You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2021/04/01 11:10:11 UTC
[isis] branch master updated (6d0aee4 -> bd47afc)
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git.
from 6d0aee4 ISIS-2573: make Interaction attributes part of API (applib)
new 4c2b66f ISIS-2484: fixes nav link
new 75eb078 ISIS-2484: regen projdoc.
new be718c0 Merge branch '2.0.0-M5'
new a6cea0d ISIS-2484: updates committer guide
new bd47afc Merge branch '2.0.0-M5'
The 5 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.run/isis-tooling-cli (index).run.xml | 2 +-
.run/isis-tooling-cli (overview).run.xml | 2 +-
.run/isis-tooling-cli (projdoc).run.xml | 2 +-
antora/components/comguide/modules/ROOT/nav.adoc | 27 +++++---
.../ROOT/pages/post-release-successful.adoc | 79 +--------------------
.../modules/ROOT/pages/updating-the-website.adoc | 33 +++++++--
.../ROOT/partials/publish-and-index-website.adoc | 80 ++++++++++++++++++++++
.../commons/pages/index/collections/Can.adoc | 51 +-------------
.../changetracking/EntityChangeTrackerDefault.adoc | 4 +-
.../jdo/applib/services/JdoSupportService.adoc | 2 +
core/adoc/modules/_overview/pages/about.adoc | 12 ++--
.../jpa/adoc/modules/ROOT/partials/module-nav.adoc | 3 +-
12 files changed, 143 insertions(+), 154 deletions(-)
copy starters/adoc/modules/starters/pages/simpleapp-script-jdo.adoc => antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc (51%)
create mode 100644 antora/components/comguide/modules/ROOT/partials/publish-and-index-website.adoc
[isis] 02/05: ISIS-2484: regen projdoc.
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 75eb0787ff238d68d5596d1e896e95b1eb7dc2f2
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Apr 1 11:42:48 2021 +0100
ISIS-2484: regen projdoc.
---
.run/isis-tooling-cli (index).run.xml | 2 +-
.run/isis-tooling-cli (overview).run.xml | 2 +-
.run/isis-tooling-cli (projdoc).run.xml | 2 +-
.../commons/pages/index/collections/Can.adoc | 51 ++--------------------
.../changetracking/EntityChangeTrackerDefault.adoc | 4 +-
.../jdo/applib/services/JdoSupportService.adoc | 2 +
core/adoc/modules/_overview/pages/about.adoc | 12 ++---
7 files changed, 16 insertions(+), 59 deletions(-)
diff --git a/.run/isis-tooling-cli (index).run.xml b/.run/isis-tooling-cli (index).run.xml
index 29a5aeb..8707b26 100644
--- a/.run/isis-tooling-cli (index).run.xml
+++ b/.run/isis-tooling-cli (index).run.xml
@@ -4,7 +4,7 @@
<option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
<option name="MAIN_CLASS_NAME" value="org.apache.isis.tooling.cli.Cli" />
<module name="isis-tooling-cli" />
- <option name="PROGRAM_PARAMETERS" value="-p . -o antora/components/refguide-index index " />
+ <option name="PROGRAM_PARAMETERS" value="-p . -x antora/components/refguide-index index " />
<extension name="net.ashald.envfile">
<option name="IS_ENABLED" value="false" />
<option name="IS_SUBST" value="false" />
diff --git a/.run/isis-tooling-cli (overview).run.xml b/.run/isis-tooling-cli (overview).run.xml
index 5f75cff..5fbe480 100644
--- a/.run/isis-tooling-cli (overview).run.xml
+++ b/.run/isis-tooling-cli (overview).run.xml
@@ -44,7 +44,7 @@
<option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
<option name="MAIN_CLASS_NAME" value="org.apache.isis.tooling.cli.Cli" />
<module name="isis-tooling-cli" />
- <option name="PROGRAM_PARAMETERS" value="-p . -r core/adoc overview" />
+ <option name="PROGRAM_PARAMETERS" value="-p . -w core/adoc overview" />
<extension name="net.ashald.envfile">
<option name="IS_ENABLED" value="false" />
<option name="IS_SUBST" value="false" />
diff --git a/.run/isis-tooling-cli (projdoc).run.xml b/.run/isis-tooling-cli (projdoc).run.xml
index dae02a7..6791ec0 100644
--- a/.run/isis-tooling-cli (projdoc).run.xml
+++ b/.run/isis-tooling-cli (projdoc).run.xml
@@ -4,7 +4,7 @@
<option name="ALTERNATIVE_JRE_PATH_ENABLED" value="true" />
<option name="MAIN_CLASS_NAME" value="org.apache.isis.tooling.cli.Cli" />
<module name="isis-tooling-cli" />
- <option name="PROGRAM_PARAMETERS" value="-p . -r core/adoc -o antora/components/refguide-index projdoc" />
+ <option name="PROGRAM_PARAMETERS" value="-p . -w core/adoc -x antora/components/refguide-index projdoc" />
<extension name="net.ashald.envfile">
<option name="IS_ENABLED" value="false" />
<option name="IS_SUBST" value="false" />
diff --git a/antora/components/refguide-index/modules/commons/pages/index/collections/Can.adoc b/antora/components/refguide-index/modules/commons/pages/index/collections/Can.adoc
index 1dec8f8..3b0a393 100644
--- a/antora/components/refguide-index/modules/commons/pages/index/collections/Can.adoc
+++ b/antora/components/refguide-index/modules/commons/pages/index/collections/Can.adoc
@@ -32,11 +32,10 @@ interface Can<T> {
Can<T> empty() // <.>
Can<T> ofNullable(T element) // <.>
Can<T> ofSingleton(T element) // <.>
- Can<T> of(T... array) // <.>
- Can<T> ofArray(T[] array) // <.>
+ Can<T> of(T... array)
+ Can<T> ofArray(T[] array)
Can<T> ofCollection(Collection<T> collection) // <.>
- Can<T> ofIterable(Iterable<T> iterable) // <.>
- Can<T> ofEnumeration(Enumeration<T> enumeration) // <.>
+ Can<T> ofIterable(Iterable<T> iterable)
Can<T> ofStream(Stream<T> stream) // <.>
Can<T> ofInstance(Instance<T> instance) // <.>
Can<T> reverse() // <.>
@@ -122,31 +121,11 @@ Returns either a _Can_ with the given _element_ or an empty _Can_ if the _elemen
--
Returns either a _Can_ with the given _element_ or throws if the _element_ is _null_ .
--
-<.> xref:#of__T[of(T)]
-+
---
-Var-arg version of _Can#ofArray(Object[])_ .
---
-<.> xref:#ofArray__T[][ofArray(T[])]
-+
---
-Returns either a _Can_ with all the elements from given _array_ or an empty _Can_ if the _array_ is _null_ . Any elements equal to _null_ are ignored and will not be contained in the resulting _Can_ .
---
<.> xref:#ofCollection__Collection[ofCollection(Collection)]
+
--
Returns either a _Can_ with all the elements from given _collection_ or an empty _Can_ if the _collection_ is _null_ . Any elements equal to _null_ are ignored and will not be contained in the resulting _Can_ .
--
-<.> xref:#ofIterable__Iterable[ofIterable(Iterable)]
-+
---
-Returns either a _Can_ with all the elements from given _iterable_ or an empty _Can_ if the _iterable_ is _null_ . Any elements equal to _null_ are ignored and will not be contained in the resulting _Can_ .
---
-<.> xref:#ofEnumeration__Enumeration[ofEnumeration(Enumeration)]
-+
---
-Returns either a _Can_ with all the elements from given _enumeration_ or an empty _Can_ if the _enumeration_ is _null_ . Any elements equal to _null_ are ignored and will not be contained in the resulting _Can_ .
---
<.> xref:#ofStream__Stream[ofStream(Stream)]
+
--
@@ -291,40 +270,16 @@ Returns either a _Can_ with the given _element_ or an empty _Can_ if the _elemen
Returns either a _Can_ with the given _element_ or throws if the _element_ is _null_ .
-[#of__T]
-=== of(T)
-
-Var-arg version of _Can#ofArray(Object[])_ .
-
-[#ofArray__T[]]
-=== ofArray(T[])
-
-Returns either a _Can_ with all the elements from given _array_ or an empty _Can_ if the _array_ is _null_ . Any elements equal to _null_ are ignored and will not be contained in the resulting _Can_ .
-
[#ofCollection__Collection]
=== ofCollection(Collection)
Returns either a _Can_ with all the elements from given _collection_ or an empty _Can_ if the _collection_ is _null_ . Any elements equal to _null_ are ignored and will not be contained in the resulting _Can_ .
-[#ofIterable__Iterable]
-=== ofIterable(Iterable)
-
-Returns either a _Can_ with all the elements from given _iterable_ or an empty _Can_ if the _iterable_ is _null_ . Any elements equal to _null_ are ignored and will not be contained in the resulting _Can_ .
-
-[#ofEnumeration__Enumeration]
-=== ofEnumeration(Enumeration)
-
-Returns either a _Can_ with all the elements from given _enumeration_ or an empty _Can_ if the _enumeration_ is _null_ . Any elements equal to _null_ are ignored and will not be contained in the resulting _Can_ .
-
-As side-effect, consumes given _enumeration_ .
-
[#ofStream__Stream]
=== ofStream(Stream)
Returns either a _Can_ with all the elements from given _stream_ or an empty _Can_ if the _stream_ is _null_ . Any elements equal to _null_ are ignored and will not be contained in the resulting _Can_ .
-As side-effect, consumes given _stream_ .
-
[#ofInstance__Instance]
=== ofInstance(Instance)
diff --git a/antora/components/refguide-index/modules/core/pages/index/transaction/changetracking/EntityChangeTrackerDefault.adoc b/antora/components/refguide-index/modules/core/pages/index/transaction/changetracking/EntityChangeTrackerDefault.adoc
index 03c55e0..1a91092 100644
--- a/antora/components/refguide-index/modules/core/pages/index/transaction/changetracking/EntityChangeTrackerDefault.adoc
+++ b/antora/components/refguide-index/modules/core/pages/index/transaction/changetracking/EntityChangeTrackerDefault.adoc
@@ -8,7 +8,7 @@
----
class EntityChangeTrackerDefault {
void onPreCommit(TransactionBeforeCompletionEvent event) // <.>
- Optional<EntityChanges> getEntityChanges(final java.sql.Timestamp timestamp, final String userName)
+ EntityChanges getEntityChanges(final java.sql.Timestamp timestamp, final String userName)
Interaction currentInteraction()
String asString(Object object)
int numberEntitiesLoaded()
@@ -20,7 +20,7 @@ class EntityChangeTrackerDefault {
void recognizeLoaded(ManagedObject entity)
void recognizePersisting(ManagedObject entity)
void recognizeUpdating(ManagedObject entity)
- Can<EntityPropertyChange> getPropertyChanges(final java.sql.Timestamp timestamp, final String userName, final TransactionId txId)
+ Stream<EntityPropertyChange> streamPropertyChanges(final java.sql.Timestamp timestamp, final String userName, final TransactionId txId)
}
----
diff --git a/antora/components/refguide-index/modules/persistence/pages/index/jdo/applib/services/JdoSupportService.adoc b/antora/components/refguide-index/modules/persistence/pages/index/jdo/applib/services/JdoSupportService.adoc
index 5ccc033..12e01e4 100644
--- a/antora/components/refguide-index/modules/persistence/pages/index/jdo/applib/services/JdoSupportService.adoc
+++ b/antora/components/refguide-index/modules/persistence/pages/index/jdo/applib/services/JdoSupportService.adoc
@@ -136,3 +136,5 @@ For RDBMS any single-valued member will be fetched in the original SQL query, bu
=== disableMultivaluedFetch(Query)
Fetch Optimization
+
+include::hooks/JdoSupportService_010-examples-and-usage.adoc[]
diff --git a/core/adoc/modules/_overview/pages/about.adoc b/core/adoc/modules/_overview/pages/about.adoc
index 0f0eaf1..65ac959 100644
--- a/core/adoc/modules/_overview/pages/about.adoc
+++ b/core/adoc/modules/_overview/pages/about.adoc
@@ -3764,22 +3764,22 @@ skinparam rectangle<<11>> {
FontColor #fffffe
BorderColor #2E6295
}
-skinparam rectangle<<23>> {
+skinparam rectangle<<12>> {
BackgroundColor #438dd5
FontColor #fffffe
BorderColor #2E6295
}
-skinparam rectangle<<12>> {
+skinparam rectangle<<23>> {
BackgroundColor #438dd5
FontColor #fffffe
BorderColor #2E6295
}
-skinparam rectangle<<13>> {
+skinparam rectangle<<24>> {
BackgroundColor #438dd5
FontColor #fffffe
BorderColor #2E6295
}
-skinparam rectangle<<24>> {
+skinparam rectangle<<13>> {
BackgroundColor #438dd5
FontColor #fffffe
BorderColor #2E6295
@@ -3859,12 +3859,12 @@ skinparam rectangle<<20>> {
FontColor #fffffe
BorderColor #2E6295
}
-skinparam rectangle<<21>> {
+skinparam rectangle<<10>> {
BackgroundColor #438dd5
FontColor #fffffe
BorderColor #2E6295
}
-skinparam rectangle<<10>> {
+skinparam rectangle<<21>> {
BackgroundColor #438dd5
FontColor #fffffe
BorderColor #2E6295
[isis] 01/05: ISIS-2484: fixes nav link
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 4c2b66f27cb16608bbfc05ab980bd95d98083f35
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Apr 1 11:37:24 2021 +0100
ISIS-2484: fixes nav link
---
persistence/jpa/adoc/modules/ROOT/partials/module-nav.adoc | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/persistence/jpa/adoc/modules/ROOT/partials/module-nav.adoc b/persistence/jpa/adoc/modules/ROOT/partials/module-nav.adoc
index 3a78cd6..052539a 100644
--- a/persistence/jpa/adoc/modules/ROOT/partials/module-nav.adoc
+++ b/persistence/jpa/adoc/modules/ROOT/partials/module-nav.adoc
@@ -1,6 +1,5 @@
* xref:pjpa:ROOT:setup-and-configuration.adoc[Setup and Configuration]
* xref:pjpa:ROOT:db-schemas.adoc[DB Schemas]
-* xref:pjpa:ROOT:mapping-guide.adoc[Mapping
-Guide]
+* xref:pjpa:ROOT:mapping-guide.adoc[Mapping Guide]
* xref:pjpa:ROOT:dependency-injection.adoc[Dependency Injection]
* xref:pjpa:ROOT:domain-services.adoc[Domain Services]
[isis] 05/05: Merge branch '2.0.0-M5'
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit bd47afcea66371134be90f2422df4e7f722a25f1
Merge: be718c0 a6cea0d
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Apr 1 12:09:56 2021 +0100
Merge branch '2.0.0-M5'
antora/components/comguide/modules/ROOT/nav.adoc | 27 +++++---
.../ROOT/pages/post-release-successful.adoc | 79 +--------------------
.../modules/ROOT/pages/updating-the-website.adoc | 38 ++++++++++
.../ROOT/partials/publish-and-index-website.adoc | 80 ++++++++++++++++++++++
4 files changed, 135 insertions(+), 89 deletions(-)
[isis] 04/05: ISIS-2484: updates committer guide
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit a6cea0dfcc68fdb84a977b302228f1da1382fca1
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Apr 1 12:09:29 2021 +0100
ISIS-2484: updates committer guide
---
antora/components/comguide/modules/ROOT/nav.adoc | 27 +++++---
.../ROOT/pages/post-release-successful.adoc | 79 +--------------------
.../modules/ROOT/pages/updating-the-website.adoc | 38 ++++++++++
.../ROOT/partials/publish-and-index-website.adoc | 80 ++++++++++++++++++++++
4 files changed, 135 insertions(+), 89 deletions(-)
diff --git a/antora/components/comguide/modules/ROOT/nav.adoc b/antora/components/comguide/modules/ROOT/nav.adoc
index b6723f8..9dc2600 100644
--- a/antora/components/comguide/modules/ROOT/nav.adoc
+++ b/antora/components/comguide/modules/ROOT/nav.adoc
@@ -1,14 +1,19 @@
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-* xref:merging-a-pull-request.adoc[Merging a Pull Request]
-* xref:applying-patches.adoc[Applying Patches]
-* xref:cutting-a-release.adoc[Cutting a Release]
-* xref:verifying-releases.adoc[Verifying Releases]
-* xref:post-release-successful.adoc[Post Release (Successful)]
-* xref:post-release-unsuccessful.adoc[Post Release (Unsuccessful)]
-* xref:key-generation.adoc[Key Generation]
-* xref:algolia-search.adoc[Appendix: Algolia Search]
-* xref:release-process-prereqs.adoc[Appendix: Release Process Prereqs]
-* xref:policies.adoc[Appendix: Policies]
-* xref:pmc-notes.adoc[Appendix: PMC Notes]
+* Occasionally
+** xref:merging-a-pull-request.adoc[Merging a Pull Request]
+** xref:applying-patches.adoc[Applying Patches]
+** xref:updating-the-website.adoc[Updating the Website]
+* Release
+** xref:cutting-a-release.adoc[Cutting a Release]
+** xref:verifying-releases.adoc[Verifying Releases]
+** Post Release
+*** xref:post-release-successful.adoc[Post Release (Successful)]
+*** xref:post-release-unsuccessful.adoc[Post Release (Unsuccessful)]
+* Appendices
+** xref:key-generation.adoc[Key Generation]
+** xref:algolia-search.adoc[Algolia Search]
+** xref:release-process-prereqs.adoc[Release Process Prereqs]
+** xref:policies.adoc[Policies]
+** xref:pmc-notes.adoc[PMC Notes]
diff --git a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc
index 086e784..c04ecd3 100644
--- a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc
@@ -385,86 +385,9 @@ Finally, revert the last commit (backing out changes to `site.yml`):
git revert HEAD
----
-[#publish-website]
-== Publish website
-We now copy the results of the Antora website generation over to the `isis-site` repo:
+include::partial$publish-and-index-website.adoc[]
-* in the `isis-site` repo, check out the `asf-site` branch:
-+
-[source,bash,subs="attributes+"]
-----
-cd ../isis-site
-
-git checkout asf-site
-git pull --ff-only
-----
-
-* still in the `isis-site` repo, delete all the files in `content/` _except_ for the `schema` and `versions` directories:
-+
-[source,bash,subs="attributes+"]
-----
-pushd content
-for a in $(ls -1 | grep -v schema | grep -v versions)
-do
- rm -rf $a
-done
-popd
-----
-
-* Copy the generated Antora site to `isis-site` repo's `contents` directory:
-+
-[source,bash,subs="attributes+"]
-----
-cd ../isis
-
-cp -Rf antora/target/site/* ../isis-site/content/.
-----
-
-* Back in the `isis-site` repo, commit the changes and preview:
-+
-[source,bash,subs="attributes+"]
-----
-cd ../isis-site
-
-git add .
-git commit -m "$ISISJIRA : production changes to website"
-
-sh preview.sh
-----
-
-* If everything looks ok, then push the changes to make live, and switch back to the `isis` repo:
-+
-[source,bash,subs="attributes+"]
-----
-git push origin asf-site
-----
-
-[#update-the-algolia-search-index]
-== Update the Algolia search index
-
-Create a `algolia.env` file holding the `APP_ID` and the admin `API_KEY`, in the root of `isis-site`:
-
-[source,ini]
-.algolia.env
-----
-APPLICATION_ID=...
-API_KEY=...
-----
-
-CAUTION: This file should not be checked into the repo, because the API_KEY allows the index to be modified or deleted.
-
-We use the Algolia-provided link:https://hub.docker.com/r/algolia/docsearch-scraper[docker image] for the crawler to perform the search (as per the link:as per https://docsearch.algolia.com/docs/run-your-own/#run-the-crawl-from-the-docker-image[docs]):
-
-[source,bash]
-----
-cd content
-docker run -it --env-file=../algolia.env -e "CONFIG=$(cat ../algolia-config.json | jq -r tostring)" algolia/docsearch-scraper
-----
-
-This posts the index up to the link:https://algolia.com[Algolia] site.
-
-NOTE: Additional config options for the crawler can be found link:https://www.algolia.com/doc/api-reference/crawler/[here].
== Merge in release branch
diff --git a/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc b/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc
new file mode 100644
index 0000000..63748b0
--- /dev/null
+++ b/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc
@@ -0,0 +1,38 @@
+= Updating the Website
+
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
+:page-partial:
+
+As part of the release process we xref:post-release-successful.adoc#generate-website[generate] and publish the website.
+An (intentional) side-effect of this process is to create a branch for the release (that is, `{page-isisrel}`).
+This branch can then be used for documentation updates.
+
+== Update docs
+
+In the regular `isis` repo:
+
+* Check out the branch:
++
+[source,bash,subs="attributes+"]
+----
+git checkout {page-isisrel}
+----
+
+* make documentation updates, and commit changes
+
+* generate the website:
++
+[source,bash,subs="attributes+"]
+----
+sh preview.sh
+----
++
+This will write to `antora/target/site`; we'll use the results in the xref:#publish-website[next section].
++
+NOTE: this requires Java 11 for the projdoc tooling.
+
+
+
+
+include::partial$publish-and-index-website.adoc[]
+
diff --git a/antora/components/comguide/modules/ROOT/partials/publish-and-index-website.adoc b/antora/components/comguide/modules/ROOT/partials/publish-and-index-website.adoc
new file mode 100644
index 0000000..89bcb8b
--- /dev/null
+++ b/antora/components/comguide/modules/ROOT/partials/publish-and-index-website.adoc
@@ -0,0 +1,80 @@
+[#publish-website]
+== Publish website
+
+We now copy the results of the Antora website generation over to the `isis-site` repo:
+
+* in the `isis-site` repo, check out the `asf-site` branch:
++
+[source,bash,subs="attributes+"]
+----
+cd ../isis-site
+
+git checkout asf-site
+git pull --ff-only
+----
+
+* still in the `isis-site` repo, delete all the files in `content/` _except_ for the `schema` and `versions` directories:
++
+[source,bash,subs="attributes+"]
+----
+pushd content
+for a in $(ls -1 | grep -v schema | grep -v versions)
+do
+ rm -rf $a
+done
+popd
+----
+
+* Copy the generated Antora site to `isis-site` repo's `contents` directory:
++
+[source,bash,subs="attributes+"]
+----
+cd ../isis
+
+cp -Rf antora/target/site/* ../isis-site/content/.
+----
+
+* Back in the `isis-site` repo, commit the changes and preview:
++
+[source,bash,subs="attributes+"]
+----
+cd ../isis-site
+
+git add .
+git commit -m "$ISISJIRA : production changes to website"
+
+sh preview.sh
+----
+
+* If everything looks ok, then push the changes to make live, and switch back to the `isis` repo:
++
+[source,bash,subs="attributes+"]
+----
+git push origin asf-site
+----
+
+[#update-the-algolia-search-index]
+== Update the Algolia search index
+
+Create a `algolia.env` file holding the `APP_ID` and the admin `API_KEY`, in the root of `isis-site`:
+
+[source,ini]
+.algolia.env
+----
+APPLICATION_ID=...
+API_KEY=...
+----
+
+CAUTION: This file should not be checked into the repo, because the API_KEY allows the index to be modified or deleted.
+
+We use the Algolia-provided link:https://hub.docker.com/r/algolia/docsearch-scraper[docker image] for the crawler to perform the search (as per the link:as per https://docsearch.algolia.com/docs/run-your-own/#run-the-crawl-from-the-docker-image[docs]):
+
+[source,bash]
+----
+cd content
+docker run -it --env-file=../algolia.env -e "CONFIG=$(cat ../algolia-config.json | jq -r tostring)" algolia/docsearch-scraper
+----
+
+This posts the index up to the link:https://algolia.com[Algolia] site.
+
+NOTE: Additional config options for the crawler can be found link:https://www.algolia.com/doc/api-reference/crawler/[here].
[isis] 03/05: Merge branch '2.0.0-M5'
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit be718c0296f0274980fde20be2bfcd17f0b8b3ab
Merge: 6d0aee4 75eb078
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Apr 1 11:43:22 2021 +0100
Merge branch '2.0.0-M5'
.run/isis-tooling-cli (index).run.xml | 2 +-
.run/isis-tooling-cli (overview).run.xml | 2 +-
.run/isis-tooling-cli (projdoc).run.xml | 2 +-
.../commons/pages/index/collections/Can.adoc | 51 ++--------------------
.../changetracking/EntityChangeTrackerDefault.adoc | 4 +-
.../jdo/applib/services/JdoSupportService.adoc | 2 +
core/adoc/modules/_overview/pages/about.adoc | 12 ++---
.../jpa/adoc/modules/ROOT/partials/module-nav.adoc | 3 +-
8 files changed, 17 insertions(+), 61 deletions(-)