This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch maint-2.0.0-M1
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/maint-2.0.0-M1 by this push:
new 7310df4 ISIS-1810: updates for publish procedure of documentation
7310df4 is described below
commit 7310df4e2941ee609e74556e41fd72cb04c93d53
Author: danhaywood <d...@haywood-associates.co.uk>
AuthorDate: Sun Aug 12 17:41:23 2018 +0100
ISIS-1810: updates for publish procedure of documentation
---
.../cgcom/_cgcom_asciidoc-publish-procedure.adoc | 21 ++++++++++++++++-----
adocs/template/document.html.erb | 2 +-
2 files changed, 17 insertions(+), 6 deletions(-)
diff --git
a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_asciidoc-publish-procedure.adoc
b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_asciidoc-publish-procedure.adoc
index 2bf1ce9..637fc9a 100644
---
a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_asciidoc-publish-procedure.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_asciidoc-publish-procedure.adoc
@@ -116,23 +116,34 @@ This does the following:
* deletes everything under `content` (except `content/versions`)
* generates documentation and copies to `content/versions/SNAPSHOT`
++
+Including fixing up line endings, standardizing on unix-style LFs.
* copies over current home page (`index.html`)
* reinstates `content/*` with the contents of `content/versions/current`
-It also fixes up line endings, standardizing on unix-style LFs.
+In other words, the effect of running `publish.sh` is in essence to overwrite
`content/versions/SNAPSHOT` and to overwrite `index.html`, but leave everything
else as it is.
+
+[NOTE]
+====
+The version on the header of each generated document is hard-coded in the
`adocs/template/document.html.erb` file.
-In other words, the effect of running `publish.sh` is in essence to overwrite
`SNAPSHOT` and to overwrite `index.html`.
+This should therefore be updated whenever working on a new release.
+====
-To publish a new release, therefore:
+=== New release
-* run `publish.sh` first time to update `content/versions/SNAPSHOT`
+When a new release is published, we therefore need to do a little extra work:
+
+* run `publish.sh` a first time
++
+This will update `content/versions/SNAPSHOT`
* delete `content/versions/current`
* rename `content/versions/SNAPSHOT` to `content/versions/current`
* run `publish.sh` a second time.
+
This has the effect of "promoting" `content/versions/current` to `content/*`
-* (optionally) copy `content/versions/current` to `content/versions/N.N.N`
+* (optionally) also copy `content/versions/current` to `content/versions/N.N.N`
+
where `N.N.N` is the release number
diff --git a/adocs/template/document.html.erb b/adocs/template/document.html.erb
index f4c7966..3af2f68 100644
--- a/adocs/template/document.html.erb
+++ b/adocs/template/document.html.erb
@@ -203,7 +203,7 @@
</form>
</div>
- <p class="nav navbar-text navbar-right small">v1.16.3-SNAPSHOT</p>
+ <p class="nav navbar-text navbar-right small">v2.0.0-M1</p>
</div>
</div>
