[2/3] jspwiki-site git commit: reflow edit_website + added how to publish javadocs

[ju...@apache.org]

reflow edit_website + added how to publish javadocs


Project: http://git-wip-us.apache.org/repos/asf/jspwiki-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/jspwiki-site/commit/981f10a7
Tree: http://git-wip-us.apache.org/repos/asf/jspwiki-site/tree/981f10a7
Diff: http://git-wip-us.apache.org/repos/asf/jspwiki-site/diff/981f10a7

Branch: refs/heads/jbake
Commit: 981f10a776f0045bfd7ce2d27d08160cae7cdb3a
Parents: e1e7a66
Author: Juan Pablo Santos Rodriguez <ju...@apache.org>
Authored: Sat Jul 1 19:51:34 2017 +0200
Committer: Juan Pablo Santos Rodriguez <ju...@apache.org>
Committed: Sat Jul 1 19:51:34 2017 +0200

----------------------------------------------------------------------
 .../jbake/content/development/edit_website.md   | 61 +++++++++-----------
 1 file changed, 26 insertions(+), 35 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/jspwiki-site/blob/981f10a7/src/main/jbake/content/development/edit_website.md
----------------------------------------------------------------------
diff --git a/src/main/jbake/content/development/edit_website.md b/src/main/jbake/content/development/edit_website.md
index ebfc757..ff30bc0 100755
--- a/src/main/jbake/content/development/edit_website.md
+++ b/src/main/jbake/content/development/edit_website.md
@@ -8,61 +8,51 @@ Apache JSPWiki website
 
 (adapted from [Apache Guacamole site](https://github.com/apache/incubator-guacamole-website))
 
-[This repository](https://git-wip-us.apache.org/repos/asf?p=jspwiki-site.git) contains the source for the website of Apache JSPWiki, so it can be deployed via [gitpubsub](https://blogs.apache.org/infra/entry/git_based_websites_available).
+Most of this website is powered by Apache JSPWiki itself, under [http://jspwiki-wiki.apache.org]()
 
-The website itself is completely static, being automatically generated by [JBake](https://jbake.org/) prior to deployment. The content 
-of the website is written in a mixture of Freemarker templates and Markdown. Templated content is interpreted only 
-at build time, with the final result being completely static.
+[This repository](https://git-wip-us.apache.org/repos/asf?p=jspwiki-site.git) contains the source for the website of Apache JSPWiki, available under [http://jspwiki.apache.org](), which can be deployed via [gitpubsub](https://blogs.apache.org/infra/entry/git_based_websites_available).
+
+This website itself is completely static, being automatically generated by [JBake](https://jbake.org/) prior to deployment. The content of the website is written in a mixture of Freemarker templates and Markdown. Templated content is interpreted only at build time, with the final result being completely static. This allows us to have a fast, backup site if needed, and also to publish our [apidocs](/apidocs/index.html) easily (see [publishing apidocs](/development/edit_website.html#publishing-apidocs) below).
+
+To facilitate ease of development and testing, this repository also contains a couple of build scripts, `ci.sh` and `mvn-ci.sh`, the usage of which is documented below.
 
-To facilitate ease of development and testing, this repository also contains a couple of build scripts, `ci.sh` 
-and `mvn-ci.sh`, the usage of which is documented below.
 Table of contents
 -----------------
 
-* [Repository structure](#repository-structure)
-* [Build prerequisites](#build-prerequisites)
-* [Testing changes locally](#testing-changes-locally)
-* [Publishing changes](#publishing-changes)
+* [Repository structure](/development/edit_website.html#repository-structure)
+* [Build prerequisites](/development/edit_website.html#build-prerequisites)
+* [Testing changes locally](/development/edit_website.html#testing-changes-locally)
+* [Publishing changes](/development/edit_website.html#publishing-changes)
 
 ## Repository structure<a name="repository-structure"></a>
 
-In addition to the `LICENSE` and `NOTICE` files required of any proper Apache-licensed project, 
-the repository contains the following critical files:
+In addition to the `LICENSE` and `NOTICE` files required of any proper Apache-licensed project, the repository contains the following critical files:
 
 * **`./pom.xml`**: orchestrates the maven website build
 * **`./ci.sh`**: script, meant to be run by a CI server, to build and deploy the website.
 * **`./mvn-ci.sh`**: script to build and deploy the website using Maven.
 * **`./src/main/jbake/`**: standard [jbake maven plugin structure](https://github.com/ingenieux/jbake-maven-plugin), contains three subdirectories:
-    * `./src/main/jbake/assets/`: The assets directory is where you should place your static files such as images, 
-    CSS files, JavaScript files, etc. These files are copied over to the baked output as is. You can create any 
-    directory structure you like in the assets directory and this structure will be maintained when copied.
-    * `./src/main/jbake/content/`: holds content files, with the extension of these files determining what 
-    type of content it contains (i.e.: `.md` for [Markdown](http://daringfireball.net/projects/markdown/syntax), `.html` for raw HTML, etc.)
-    * `./src/main/jbake/templates/`: holds templates files, with the extension of these files determining 
-    the templates engine (i.e.: `.ftl` for [Freemarker](https://freemarker.apache.org/), `.thyme` for [Thymeleaf](http://www.thymeleaf.org/), etc.)
-* **`./content/`**: the actual content served for jspwiki.apache.org, see [publishing changes](#publishing-changes) below
+    * `./src/main/jbake/assets/`: The assets directory is where you should place your static files such as images, CSS files, JavaScript files, etc. These files are copied over to the baked output as is. You can create any directory structure you like in the assets directory and this structure will be maintained when copied.
+    * `./src/main/jbake/content/`: holds content files, with the extension of these files determining what type of content it contains (i.e.: `.md` for [Markdown](http://daringfireball.net/projects/markdown/syntax), `.html` for raw HTML, etc.).
+    * `./src/main/jbake/templates/`: holds templates files, with the extension of these files determining the templates engine (i.e.: `.ftl` for [Freemarker](https://freemarker.apache.org/), `.thyme` for [Thymeleaf](http://www.thymeleaf.org/), etc.).
+* **`./content/`**: the actual content served for jspwiki.apache.org, see [publishing changes](/development/edit_website.html#publishing-changes) below.
 
 ## Build prerequisites<a name="build-prerequisites"></a>
 
-The CI build (`ci.sh`) needs Java 7 and a JBake installation under `$JBAKE_HOME`. This script is run at [ASF's Jenkins instance](https://builds.apache.org/job/jspwiki-site/). 
-As there isn't a Maven installation at the nodes which perform this job, this script only takes the changes from the "jbake" branch, 
-generates the site and puts it on the "asf-site" branch. As for now, javadocs must be pushed locally through the Maven build script.
+The CI build (`ci.sh`) needs Java 7 and a JBake installation under `$JBAKE_HOME`. This script is run at [ASF's Jenkins instance](https://builds.apache.org/job/jspwiki-site/). As there isn't a Maven installation at the nodes which perform this job, this script only takes the changes from the "jbake" branch, generates the site and puts it on the "asf-site" branch. As for now, javadocs must be pushed locally through the Maven build script.
 
-The Maven build (`mvn-ci.sh`) needs at least Maven 3.1.1 and Java 7, thus these must be installed first. It's essentially the 
-same build as the CI build, but done through Maven. This allows us to generate the site and also put the javadocs in there.
+The Maven build (`mvn-ci.sh`) needs at least Maven 3.1.1 and Java 7, thus these must be installed first. It's essentially the same build as the CI build, but done through Maven. This allows us to generate the site and also put the javadocs in there.
 
 ## Testing changes locally<a name="testing-changes-locally"></a>
 
-Just run `mvn clean jbake:inline` and the site will be accesible through http://localhost:8080. Changes will be reloaded 
-on the fly. When done testing your local changes, press `Enter` to stop the web server and return to the shell.
+Just run `mvn clean jbake:inline` and the site will be accesible through http://localhost:8080. Changes will be reloaded on the fly. When done testing your local changes, press `Enter` to stop the web server and return to the shell.
 
-In order to be able to navigate locally, you'll need to edit the `site.host` property at `./src/main/jbake/jbake.properties`.
+In order to be able to navigate locally, you'll need to edit the `site.host` property at `./src/main/jbake/jbake.properties`. 
 Do **NOT** commit that change.
 
 ## Publishing changes<a name="publishing-changes"></a>
 
-Changes to the website are published using Apache's [gitpubsub](https://blogs.apache.org/infra/entry/git_based_websites_available) which relies on a 
-special branch called "asf-site" containing *all website content*.
+Changes to the website are published using Apache's [gitpubsub](https://blogs.apache.org/infra/entry/git_based_websites_available) which relies on a special branch called "asf-site" containing *all website content*.
 
 In the Apache JSPWiki website repository, the "asf-site" branch is an "orphan" branch. Updating the website thus involves:
 
@@ -71,9 +61,10 @@ In the Apache JSPWiki website repository, the "asf-site" branch is an "orphan" b
 
 Second step is automated through `ci.sh` and `mvn-ci.sh` scripts. 
 
-Keep in mind that the new content must be *staged* for and committed in this branch. Once you have verified that the staged 
-content is as expected, commit your changes (along with a useful commit message describing the changes at a high level) 
-using `git commit` and publish the update using `git push origin`.
+Keep in mind that the new content must be *staged* for and committed in this branch. Once you have verified that the staged content is as expected, commit your changes (along with a useful commit message describing the changes at a high level) using `git commit` and publish the update using `git push origin`.
+
+If you wish to unstage your changes, use `git reset --hard HEAD` to return to the original state of "jbake", wiping out any local modifications. You can then return to whichever branch you were working on with `git checkout`.
+
+### Publishing apidocs<a name="publishing-apidocs"></a>
 
-If you wish to unstage your changes, use `git reset --hard HEAD` to return to the original state of "jbake", wiping 
-out any local modifications. You can then return to whichever branch you were working on with `git checkout`.
+Run the `mvn-ci.sh` script locally. This will generate the whole site with the javadocs, and push it to the `asf-site` branch. As for today, this has to be done locally, as the Jenkins' nodes which build and deploy the site don't have a Maven installation.
\ No newline at end of file