You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bd...@apache.org on 2017/06/26 13:36:37 UTC
[1/6] sling-site git commit: Fix remaining broken tables
Repository: sling-site
Updated Branches:
refs/heads/master dcf8cf920 -> acf7a37ae
Fix remaining broken tables
Project: http://git-wip-us.apache.org/repos/asf/sling-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/sling-site/commit/da2329fe
Tree: http://git-wip-us.apache.org/repos/asf/sling-site/tree/da2329fe
Diff: http://git-wip-us.apache.org/repos/asf/sling-site/diff/da2329fe
Branch: refs/heads/master
Commit: da2329fe7eaf7204c37abbdb79247bcf69af1b52
Parents: dcf8cf9
Author: Bertrand Delacretaz <bd...@apache.org>
Authored: Mon Jun 26 15:01:25 2017 +0200
Committer: Bertrand Delacretaz <bd...@apache.org>
Committed: Mon Jun 26 15:01:25 2017 +0200
----------------------------------------------------------------------
.../bundles/sling-settings-org-apache-sling-settings.md | 2 +-
content/documentation/bundles/web-console-extensions.md | 2 +-
.../documentation/the-sling-engine/the-sling-launchpad.md | 10 +++++-----
3 files changed, 7 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/sling-site/blob/da2329fe/content/documentation/bundles/sling-settings-org-apache-sling-settings.md
----------------------------------------------------------------------
diff --git a/content/documentation/bundles/sling-settings-org-apache-sling-settings.md b/content/documentation/bundles/sling-settings-org-apache-sling-settings.md
index 1d24d5b..138b653 100644
--- a/content/documentation/bundles/sling-settings-org-apache-sling-settings.md
+++ b/content/documentation/bundles/sling-settings-org-apache-sling-settings.md
@@ -9,7 +9,7 @@ The Sling Settings Bundle exposes the `SlingSettingsService` which allows access
| Method | Bundle Context Property | Description |
|--|--|--|
-| `String getSlingId()` | --- | A unique identifier of the running Sling instance. This value is created when Sling is first started and may be used to identify the instance, for example if multiple Sling instances are running on top of a Jackrabbit Repository Cluster |
+| `String getSlingId()` | (-) | A unique identifier of the running Sling instance. This value is created when Sling is first started and may be used to identify the instance, for example if multiple Sling instances are running on top of a Jackrabbit Repository Cluster |
| `String getSlingHomePath()` | `sling.home` | The absolute filesystem path to the directory where Sling stores all its content |
| `URL getSlingHome()` | `sling.home.url` | The Sling Home path as an `java.net.URL` instance |
| `Set<String> getRunModes()` | `sling.run.modes` | The active Run Modes of the running Sling instance |
http://git-wip-us.apache.org/repos/asf/sling-site/blob/da2329fe/content/documentation/bundles/web-console-extensions.md
----------------------------------------------------------------------
diff --git a/content/documentation/bundles/web-console-extensions.md b/content/documentation/bundles/web-console-extensions.md
index fef0adb..e9c1d73 100644
--- a/content/documentation/bundles/web-console-extensions.md
+++ b/content/documentation/bundles/web-console-extensions.md
@@ -31,7 +31,7 @@ The Security Provider is configured with the configuration PID `org.apache.sling
| Property | Type | Default Value | Description
|--|--|--|
| `users` | `String`, `String[]` or `Vector<String>` | admin | The list of users granted access to the Web Console |
-| `groups`| `String`, `String[]` or `Vector<String>` | --- | The list of groups whose (direct or indirect) members are granted access to the Web Console |
+| `groups`| `String`, `String[]` or `Vector<String>` | (---) | The list of groups whose (direct or indirect) members are granted access to the Web Console |
Note, that while the default value explicitly grants the *admin* user to access the Web Console it is suggested that system administrators define a special group and assign users with Web Console access to this group.
http://git-wip-us.apache.org/repos/asf/sling-site/blob/da2329fe/content/documentation/the-sling-engine/the-sling-launchpad.md
----------------------------------------------------------------------
diff --git a/content/documentation/the-sling-engine/the-sling-launchpad.md b/content/documentation/the-sling-engine/the-sling-launchpad.md
index 1b10cf7..211a905 100644
--- a/content/documentation/the-sling-engine/the-sling-launchpad.md
+++ b/content/documentation/the-sling-engine/the-sling-launchpad.md
@@ -30,9 +30,9 @@ The Java Standalone Application supports a number of command line options, which
| Option | Argument | Description |
|--|--|--|
-| `start` | -- | Open a TCP/IP server socket when starting Sling. Uses option `-j` to define the local socket address. |
-| `status` | -- | Check whether a (remote) Sling application is running. Uses option `-j` to define the address of the Sling instance to check. Note, that the Sling application terminates after checking for the (remote) Sling status. |
-| `stop` | -- | Stop a (remote) Sling application is running. Uses option `-j` to define the address of the Sling instance to stop. Note, that the Sling application tesrminates after stopping the (remote) Sling instance. |
+| `start` | (-) | Open a TCP/IP server socket when starting Sling. Uses option `-j` to define the local socket address. |
+| `status` | (-) | Check whether a (remote) Sling application is running. Uses option `-j` to define the address of the Sling instance to check. Note, that the Sling application terminates after checking for the (remote) Sling status. |
+| `stop` | (-) | Stop a (remote) Sling application is running. Uses option `-j` to define the address of the Sling instance to stop. Note, that the Sling application tesrminates after stopping the (remote) Sling instance. |
| `-j` | [ host ":" ] port | The socket address to listen on for control connections (`start` or to use as the remote endpoint for the control connection (`status` and `stop`. If this parameter has no arguments or is not specified, the address defaults to any free port on localhost/127.0.0.1. If only the port is specified localhost/127.0.0.1 is used as the host part of the address. |
| `-c` | slinghome | The directory in which Sling locates its initial configuration file `sling.properties` and where files of Sling itself such as the Apache Felix bundle archive or the JCR repository files are stored. This defaults to the `sling` folder in the current working directory. This is the value which is commonly refered to as `$\{sling.home}.`
| `-i` | launchpadhome | The launchpad directory. If not set, this is the same as `$\{sling.home}.` (since Sling Launchpad 2.4.0) |
@@ -42,8 +42,8 @@ The Java Standalone Application supports a number of command line options, which
| `-p` | port | The port to listen (default 8080) to handle HTTP requests. This option overwrites the `org.osgi.service.http.port` setting in the `sling.properties` file. |
| `-r` | path | The root servlet context path for the Http Service (default is /). This option overwrites the `org.apache.felix.http.context_path` setting in the `sling.properties` file and requires the embedded Http Service implementation to honor this property. (since Sling Launchpad 2.4.0) |
| `-D` | n=v | Sets the property `n` to the value `v`. This option can be added repeatedly setting additional properties. Any property set in this manner overwrites same named properties in the `sling.properties` file. (since Sling Launchpad 2.4.0) |
-| `-n` | -- | Don't install the shutdown hook. See [Shutdown Hook](#shutdown-hook) below. (since Sling Launchpad 2.5.2) |
-| `-h` | -- | Prints a simple usage message listing all available command line options. |
+| `-n` | (-) | Don't install the shutdown hook. See [Shutdown Hook](#shutdown-hook) below. (since Sling Launchpad 2.5.2) |
+| `-h` | (-) | Prints a simple usage message listing all available command line options. |
The Sling Standalone application looks for a definition of the `sling.home` setting in the following locations in order of precendence:
[5/6] sling-site git commit: README
Posted by bd...@apache.org.
README
Project: http://git-wip-us.apache.org/repos/asf/sling-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/sling-site/commit/bfd6ea2d
Tree: http://git-wip-us.apache.org/repos/asf/sling-site/tree/bfd6ea2d
Diff: http://git-wip-us.apache.org/repos/asf/sling-site/diff/bfd6ea2d
Branch: refs/heads/master
Commit: bfd6ea2dd0ef3c1af76460e7d104ced0ec2cd2aa
Parents: dbcdc4d
Author: Bertrand Delacretaz <bd...@apache.org>
Authored: Mon Jun 26 15:29:20 2017 +0200
Committer: Bertrand Delacretaz <bd...@apache.org>
Committed: Mon Jun 26 15:29:20 2017 +0200
----------------------------------------------------------------------
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/sling-site/blob/bfd6ea2d/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 959da18..02b3ac2 100644
--- a/README.md
+++ b/README.md
@@ -37,7 +37,7 @@ We'll have a script for that, but for now the following works:
git checkout -- jbake.properties
mv ./output /tmp
git checkout asf-site
- rsync -R /tmp/output/* .
+ rsync -r /tmp/output/* .
git commit -a -m "Updating live site"
# content should appear at https://sling.apache.org/ng/ (for now) soone
[4/6] sling-site git commit: README + test script
Posted by bd...@apache.org.
README + test script
Project: http://git-wip-us.apache.org/repos/asf/sling-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/sling-site/commit/dbcdc4df
Tree: http://git-wip-us.apache.org/repos/asf/sling-site/tree/dbcdc4df
Diff: http://git-wip-us.apache.org/repos/asf/sling-site/diff/dbcdc4df
Branch: refs/heads/master
Commit: dbcdc4dfcb7f366747447475845a043ed70db6e4
Parents: 2404b00
Author: Bertrand Delacretaz <bd...@apache.org>
Authored: Mon Jun 26 15:27:50 2017 +0200
Committer: Bertrand Delacretaz <bd...@apache.org>
Committed: Mon Jun 26 15:27:50 2017 +0200
----------------------------------------------------------------------
README.md | 38 ++++++++++++++++++++++++++++++++++----
1 file changed, 34 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/sling-site/blob/dbcdc4df/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 86ab67f..959da18 100644
--- a/README.md
+++ b/README.md
@@ -8,22 +8,51 @@ Build the site as described below, and sync the ./output folder to the asf-site
of this Git repository. The ASF's gitpubsub mechanism then synchronizes that content
on the http://sling.apache.org website.
-TODO gitpubsub is not active so far, I will request a test setup to start with.
+gitpubsub is active at https://sling.apache.org/ng/ for testing but as pages now contain some absolute links, navigation might lead back to the existing site (https://issues.apache.org/jira/browse/INFRA-14390)
## How to build the site locally
* Clone this repository
* Run `./bake.sh`
* Open http://localhost:8820/ and enjoy.
+## Publishing on the live website
+The live content is synced from the `asf-site` branch of this repository. To publish, generate the content and sync the `output` folder at the root of that branch.
+
+We'll have a script for that, but for now the following works:
+
+ ./bake.sh
+
+ # verify locally staged content at http://localhost:8820/
+
+ # if ok, commit your changes to the master branch
+
+ # if ok, set these values in jbake.properties
+ # and generate again
+ # (temporary, while testing on sling.apache.org/ng)
+ site.host=http://sling.apache.org
+ site.contextPath=/ng/
+
+ ./bake.sh
+
+ git checkout -- jbake.properties
+ mv ./output /tmp
+ git checkout asf-site
+ rsync -R /tmp/output/* .
+ git commit -a -m "Updating live site"
+
+ # content should appear at https://sling.apache.org/ng/ (for now) soone
+
## TODO
-### "Looks easy" (famous last words)
-* The `#!java` macro is not supported -> convert to monospaced code
+### Remaining fixes as of July 26th, 2017
+* HTML page title is "Apache Sling on JBake", should be the page title.
+
+### apache.org requirements
* Activate all the required links checked by https://whimsy.apache.org/site/
### Nice to have
* JBake 2.5.x does not support the `[TOC]` macro but apparently that will be available once JBake moves to https://github.com/vsch/flexmark-java , probably in its next version. We might wait for that and just mark the TOCs as unsupported for now.
-* Left menu is not yellow as on the old site (we might refresh the overall style anyway)
+* The `#!xml` and `#!java` code higlighting macros are not supported. I have left them in place for future automatic translation, once we reactivate code highlighting (using https://highlightjs.org/ maybe?)
### Final validation, activation etc.
* Review all pages
@@ -42,6 +71,7 @@ TODO gitpubsub is not active so far, I will request a test setup to start with.
* Fix broken tables: the current pegdown parser has troubles with table cells containing special characters, tables containing a single dash for example need to be converted to `(-)` as a workaround.
* Enumerate child pages in documentation/tutorials-how-tos.html and smilar pages -> replaced with a manually generated list.
* Sitemap page
+* Left menu layout is now correct
## JBake and other techn notes
* Currently using 2.5.1, see under `/bin`, docs at http://jbake.org/docs/2.5.1
[3/6] sling-site git commit: Update README TODOs
Posted by bd...@apache.org.
Update README TODOs
Project: http://git-wip-us.apache.org/repos/asf/sling-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/sling-site/commit/2404b009
Tree: http://git-wip-us.apache.org/repos/asf/sling-site/tree/2404b009
Diff: http://git-wip-us.apache.org/repos/asf/sling-site/diff/2404b009
Branch: refs/heads/master
Commit: 2404b009a3244944d316d612aea54ccba6aa0ead
Parents: 94759da
Author: Bertrand Delacretaz <bd...@apache.org>
Authored: Mon Jun 26 15:14:59 2017 +0200
Committer: Bertrand Delacretaz <bd...@apache.org>
Committed: Mon Jun 26 15:14:59 2017 +0200
----------------------------------------------------------------------
README.md | 15 ++++-----------
1 file changed, 4 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/sling-site/blob/2404b009/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index a5a323c..86ab67f 100644
--- a/README.md
+++ b/README.md
@@ -18,9 +18,7 @@ TODO gitpubsub is not active so far, I will request a test setup to start with.
## TODO
### "Looks easy" (famous last words)
-* Enumerate child pages in documentation/tutorials-how-tos.html -> replace with a manually generated list? or use tags to mark and select that content.
* The `#!java` macro is not supported -> convert to monospaced code
-* Create sitemap page
* Activate all the required links checked by https://whimsy.apache.org/site/
### Nice to have
@@ -30,15 +28,7 @@ TODO gitpubsub is not active so far, I will request a test setup to start with.
### Final validation, activation etc.
* Review all pages
* Resync the content with the current Sling website if needed, initially synced at r1798604
-
-## Broken tables
-The current pegdown parser has troubles with table cells containing special characters.
-
-The following pages still have problems with that:
-
-* http://localhost:8820/documentation/the-sling-engine/the-sling-launchpad.html
-* http://localhost:8820/documentation/bundles/sling-settings-org-apache-sling-settings.html
-* http://localhost:8820/documentation/bundles/web-console-extensions.html
+* Breadcrumbs. In http://sling.apache.org/documentation/bundles/rendering-content-default-get-servlets.html for example, provide `Home :: Documentation :: Bundles` links.
### Done
* Fix internal links like `refs.project-information.path`
@@ -49,6 +39,9 @@ The following pages still have problems with that:
* Fix references like `refs.authentication-tasks.headers.excerpt` as well as `.title` references -> replace with copies of those titles and excerpts, or use tags to mark and select
* Fix remaining `refs.` links -> those are probably broken anyway
* Test the downloads.cgi page, requires an apache.org setup (INFRA-14390) -> done at https://sling.apache.org/ng/downloads.cgi
+* Fix broken tables: the current pegdown parser has troubles with table cells containing special characters, tables containing a single dash for example need to be converted to `(-)` as a workaround.
+* Enumerate child pages in documentation/tutorials-how-tos.html and smilar pages -> replaced with a manually generated list.
+* Sitemap page
## JBake and other techn notes
* Currently using 2.5.1, see under `/bin`, docs at http://jbake.org/docs/2.5.1
[6/6] sling-site git commit: README
Posted by bd...@apache.org.
README
Project: http://git-wip-us.apache.org/repos/asf/sling-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/sling-site/commit/acf7a37a
Tree: http://git-wip-us.apache.org/repos/asf/sling-site/tree/acf7a37a
Diff: http://git-wip-us.apache.org/repos/asf/sling-site/diff/acf7a37a
Branch: refs/heads/master
Commit: acf7a37ae69804b0cd6400d1dc74cf3126497960
Parents: bfd6ea2
Author: Bertrand Delacretaz <bd...@apache.org>
Authored: Mon Jun 26 15:36:23 2017 +0200
Committer: Bertrand Delacretaz <bd...@apache.org>
Committed: Mon Jun 26 15:36:23 2017 +0200
----------------------------------------------------------------------
README.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/sling-site/blob/acf7a37a/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 02b3ac2..2bc9a8e 100644
--- a/README.md
+++ b/README.md
@@ -38,7 +38,8 @@ We'll have a script for that, but for now the following works:
mv ./output /tmp
git checkout asf-site
rsync -r /tmp/output/* .
- git commit -a -m "Updating live site"
+ git commit ... # do what's needed!
+ git push origin asf-site
# content should appear at https://sling.apache.org/ng/ (for now) soone
[2/6] sling-site git commit: Open pages based on content files
Posted by bd...@apache.org.
Open pages based on content files
Project: http://git-wip-us.apache.org/repos/asf/sling-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/sling-site/commit/94759daa
Tree: http://git-wip-us.apache.org/repos/asf/sling-site/tree/94759daa
Diff: http://git-wip-us.apache.org/repos/asf/sling-site/diff/94759daa
Branch: refs/heads/master
Commit: 94759daa81067167465ed35acfe648fcea9e47c1
Parents: da2329f
Author: Bertrand Delacretaz <bd...@apache.org>
Authored: Mon Jun 26 15:11:55 2017 +0200
Committer: Bertrand Delacretaz <bd...@apache.org>
Committed: Mon Jun 26 15:11:55 2017 +0200
----------------------------------------------------------------------
conversion-scripts/open-all-pages.sh | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/sling-site/blob/94759daa/conversion-scripts/open-all-pages.sh
----------------------------------------------------------------------
diff --git a/conversion-scripts/open-all-pages.sh b/conversion-scripts/open-all-pages.sh
index 42ae8c5..d042b23 100755
--- a/conversion-scripts/open-all-pages.sh
+++ b/conversion-scripts/open-all-pages.sh
@@ -1 +1,6 @@
-curl -s http://sling.apache.org/sitemap.html | grep 'a href' | cut -d'"' -f2 | while read f; do open http://localhost:8820$f
\ No newline at end of file
+export BASE="http://localhost:8820"
+
+find content -type f | sort | sed 's/\.md$/\.html/' | sed 's/^content//' | while read f
+do
+ open $BASE$f
+done
\ No newline at end of file