[isis] 01/03: ISIS-1813: updates the procedure for publishing website

[da...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

danhaywood pushed a commit to branch release-1.16.1-RC2
in repository https://gitbox.apache.org/repos/asf/isis.git

commit 9d00defd8cd71ea6dd3d7359f64188e6ff79ea57
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Feb 22 22:25:39 2018 +0000

    ISIS-1813: updates the procedure for publishing website
---
 .../cgcom/_cgcom_post-release-successful.adoc      | 37 ++++++++++++++++++----
 1 file changed, 31 insertions(+), 6 deletions(-)

diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-successful.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-successful.adoc
index c370d8e..c3b7ca3 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-successful.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-successful.adoc
@@ -274,16 +274,29 @@ For more information on DOAP files, see these http://projects.apache.org/doap.ht
 
 * Update the https://git-wip-us.apache.org/repos/asf/isis/repo?p=isis.git;a=blob_plain;f=STATUS;hb=HEAD[STATUS] file (in root of Apache Isis' source) should be updated with details of the new release.
 
-* commit the `.adoc` changes and publish to the `isis-site` repo.
+* commit the `.adoc` changes
 
+Now we need to publish the website.
+
+* locate `template/document.html.erb` file, and remove `-SNAPSHOT` from the navbar:
+
++
+[source,html]
+----
+<p class="nav navbar-text navbar-right small">v2.0.0-M1</p>
+----
+
+* publish to the `isis-site` repo.
+
++
 This will have published to the `SNAPSHOT` directory of the `isis-site` repo.
+
 Now, in the `isis-site` repo itself:
 
 * double check that a copy of `current` exists as a named directory under `content/versions`
 
 +
-If for any reason it isn't there, then create a copy before it gets deleted in the step below.
-Also, take a copy of the `index.html` with one that redirects up to the home page (see a few steps below for an example).
+If for any reason it isn't there, then create a copy (under `content/versions`) before it gets deleted in the step below.
 
 * delete the `current` version and then rename the just-published `SNAPSHOT` as `current`:
 
@@ -331,11 +344,23 @@ You can take a copy from one of the older named versions, or just use this text:
 
 At this point the files in the root (directly under `content`) will still be out of date; the publish process simply preserves whatever is in `content/versions/current`.
 Also, the `SNAPSHOT` will be missing (above it was renamed to `current`).
-To fix both of these issues, simply publish the website one more time (from the `isis` main repo).
+And, we also need to make sure that any future publishing of snapshots has the correct version in the navbar.
 
-Finally, preview the changes (in the `isis-site`).
-If everything looks ok, then push the changes to make live.
+Therefore:
+
+* locate `template/document.html.erb` file, and add in `-SNAPSHOT` for version in the navbar:
+
++
+[source,html]
+----
+<p class="nav navbar-text navbar-right small">v2.0.0-M2-SNAPSHOT</p>
+----
+
+* publish the website once more (from the `isis` main repo).
 
+* Finally, preview the changes (using `sh preview-html.sh` in the `isis-site`).
+
+If everything looks ok, then push the changes to make live.
 
 
 == Announce the release

-- 
To stop receiving notification emails like this one, please contact
danhaywood@apache.org.