[isis] 05/06: ISIS-1899: updates to release notes and migration notes

[da...@apache.org]

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

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

commit 7e573ad2bfab06a31be032df57699e6a7f8de69d
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Jan 6 17:30:43 2019 +0000

    ISIS-1899: updates to release notes and migration notes
---
 .../cgcom/_cgcom_post-release-successful.adoc      |  2 +-
 .../_migration-notes_1.16.0-to-1.17.0.adoc         | 29 +++++++++++++++++-----
 .../main/asciidoc/release-notes/release-notes.adoc | 12 ++++-----
 3 files changed, 30 insertions(+), 13 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 0f1b123..377edfd 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
@@ -415,7 +415,7 @@ Therefore:
 
 * publish the website once more (from the `isis` main repo).
 
-* Finally, preview the changes (using `sh preview-html.sh` in the `isis-site`).
+* Finally, preview the changes (using `sh preview.sh` in the `isis-site`).
 
 If everything looks ok, then push the changes to make live.
 
diff --git a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-1.17.0.adoc b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-1.17.0.adoc
index a795f3a..c1d4544 100644
--- a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-1.17.0.adoc
+++ b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.16.0-to-1.17.0.adoc
@@ -6,8 +6,30 @@
 
 
 
+== Sidebar Dialogs
 
-TODO
+In this release sidebar dialogs vs modal dialogs is configured globally, and they are enabled by default.
+
+To revert to previous behaviour, set the configuration property:
+
+[source,ini]
+.isis.properties
+----
+isis.viewer.wicket.dialogMode=modal
+----
+
+
+== MetaModelService
+
+To export the metamodel as XML, use `MetaModelService6#exportMetaModel(Config)`.
+
+Why would you want to do this?
+The main reason is as a regression test when moving up to new versions of the framework; you can check that the metamodel built up by the next version is the same as the previous.
+
+
+== Introspection
+
+A number of new configuration properties are available to control how introspection (the building of the framework's internal metamodel) is performed:
 
 * parallelized introspection
 ** specify `isis.reflector.introspector.parallelize`
@@ -17,8 +39,3 @@ TODO
 ** specify `isis.reflector.introspector.mode`
 ** is set to `lazy_unless_production` by default, can switch to `lazy` or `full`
 
-* sidebar dialogs
-** set `isis.viewer.wicket.dialogMode` to `modal` to retain previous behaviour
-
-* new `MetaModelService#exportMetaModel(Config)`
-
diff --git a/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc b/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
index e916674..bff7ec4 100644
--- a/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
+++ b/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
@@ -22,12 +22,12 @@ This table summarises all releases of Apache Isis to date.
 | JIRA relnotes
 
 | xref:release-notes.adoc#_release-notes_1.17.0[1.17.0]
-| dd-mm-yyyy
-| TODO
-|
-|
-|
-| TODO
+| 06-01-2019
+| Sidebar dialogs, metamodel export
+| 4
+| 17
+| 9
+| https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311171&version=12342854[Release notes for 1.17.0]
 
 | xref:release-notes.adoc#_release-notes_1.16.2[1.16.2]
 | 05-03-2018