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/02/03 07:26:07 UTC
[isis] 02/02: ISIS-2444: regenerates docs
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2516
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 3339bf2f687639f6f737a208d6fbe93eb6039e31
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Feb 3 07:25:44 2021 +0000
ISIS-2444: regenerates docs
with dos2unix run to normalise on LF line endings
---
.../modules/generated/pages/system-overview.adoc | 42 ++++++++-----
.../isis.persistence.jdo-datanucleus.impl.adoc | 69 ----------------------
preview.sh | 2 +-
scripts/ci/_adoc-gen-projdoc.sh | 19 +++++-
.../modules/tooling-cli/examples/isis-tooling.yml | 7 ++-
5 files changed, 48 insertions(+), 91 deletions(-)
diff --git a/antora/components/system/modules/generated/pages/system-overview.adoc b/antora/components/system/modules/generated/pages/system-overview.adoc
index 21fb53c..cf5cbeb 100644
--- a/antora/components/system/modules/generated/pages/system-overview.adoc
+++ b/antora/components/system/modules/generated/pages/system-overview.adoc
@@ -1415,6 +1415,7 @@ _Components_
* o.a.i.core.config.beans.IsisBeanFactoryPostProcessorForSpring
* o.a.i.core.config.beans.IsisBeanTypeRegistryDefault
* o.a.i.core.config.converters.PatternsConverter
+* o.a.i.core.config.datasources.DataSourceIntrospectionService
* o.a.i.core.config.environment.IsisLocaleInitializer
* o.a.i.core.config.environment.IsisSystemEnvironment
* o.a.i.core.config.environment.IsisTimeZoneInitializer
@@ -1547,7 +1548,7 @@ Folder: \core\runtime
_Components_
-* o.a.i.core.runtime.events.AppLifecycleEventService
+* o.a.i.core.runtime.events.MetamodelEventService
* o.a.i.core.runtime.events.TransactionEventEmitter
_Dependencies_
@@ -1576,12 +1577,11 @@ _Components_
* o.a.i.core.runtimeservices.confmenu.ConfigurationViewServiceDefault
* o.a.i.core.runtimeservices.email.EmailServiceDefault
* o.a.i.core.runtimeservices.eventbus.EventBusServiceSpring
-* o.a.i.core.runtimeservices.exceprecog.ExceptionRecognizerServiceDefault
* o.a.i.core.runtimeservices.executor.MemberExecutorServiceDefault
* o.a.i.core.runtimeservices.factory.FactoryServiceDefault
* o.a.i.core.runtimeservices.homepage.HomePageResolverServiceDefault
* o.a.i.core.runtimeservices.i18n.po.TranslationServicePo
-* o.a.i.core.runtimeservices.ixn.InteractionDtoServiceInternalDefault
+* o.a.i.core.runtimeservices.interaction.InteractionDtoServiceInternalDefault
* o.a.i.core.runtimeservices.jaxb.JaxbServiceDefault
* o.a.i.core.runtimeservices.menubars.MenuBarsLoaderServiceDefault
* o.a.i.core.runtimeservices.menubars.bootstrap3.MenuBarsServiceBS3
@@ -1591,17 +1591,23 @@ _Components_
* o.a.i.core.runtimeservices.publish.EntityPropertyChangePublisherDefault
* o.a.i.core.runtimeservices.publish.ExecutionPublisherDefault
* o.a.i.core.runtimeservices.queryresultscache.QueryResultsCacheDefault
+* o.a.i.core.runtimeservices.recognizer.ExceptionRecognizerServiceDefault
+* o.a.i.core.runtimeservices.recognizer.dae.impl.ExceptionRecognizerForDataAlreadyExists
+* o.a.i.core.runtimeservices.recognizer.dae.impl.ExceptionRecognizerForObjectNotFound
+* o.a.i.core.runtimeservices.recognizer.dae.impl.ExceptionRecognizerForOtherDataAccessProblem
+* o.a.i.core.runtimeservices.recognizer.dae.impl.ExceptionRecognizerForRelatedDataExists
+* o.a.i.core.runtimeservices.recognizer.dae.impl.ExceptionRecognizerForUnableToSaveData
* o.a.i.core.runtimeservices.repository.RepositoryServiceDefault
* o.a.i.core.runtimeservices.routing.RoutingServiceDefault
* o.a.i.core.runtimeservices.scratchpad.ScratchpadDefault
* o.a.i.core.runtimeservices.session.InteractionFactoryDefault
* o.a.i.core.runtimeservices.sudo.SudoServiceDefault
+* o.a.i.core.runtimeservices.transaction.TransactionServiceSpring
* o.a.i.core.runtimeservices.urlencoding.UrlEncodingServiceWithCompression
* o.a.i.core.runtimeservices.user.UserServiceDefault
* o.a.i.core.runtimeservices.userprof.UserProfileServiceDefault
* o.a.i.core.runtimeservices.userreg.EmailNotificationServiceDefault
* o.a.i.core.runtimeservices.wrapper.WrapperFactoryDefault
-* o.a.i.core.runtimeservices.xactn.TransactionServiceSpring
* o.a.i.core.runtimeservices.xml.XmlServiceDefault
* o.a.i.core.runtimeservices.xmlsnapshot.XmlSnapshotServiceDefault
@@ -1858,12 +1864,10 @@ Folder: \persistence\jdo\datanucleus
_Components_
* o.a.i.persistence.jdo.datanucleus.config.DnEntityDiscoveryListener
-* o.a.i.persistence.jdo.datanucleus.config.DnSettings
* o.a.i.persistence.jdo.datanucleus.entities.DnEntityStateProvider
-* o.a.i.persistence.jdo.datanucleus.exceptions.recognizers.ExceptionRecognizerForJDODataStoreException
-* o.a.i.persistence.jdo.datanucleus.exceptions.recognizers.ExceptionRecognizerForJDODataStoreExceptionIntegrityConstraintViolationForeignKeyNoActionException
-* o.a.i.persistence.jdo.datanucleus.exceptions.recognizers.ExceptionRecognizerForJDOObjectNotFoundException
-* o.a.i.persistence.jdo.datanucleus.exceptions.recognizers.ExceptionRecognizerForSQLIntegrityConstraintViolationUniqueOrIndexException
+* o.a.i.persistence.jdo.datanucleus.jdosupport.JdoSupportServiceDefault
+* o.a.i.persistence.jdo.datanucleus.metamodel.JdoDataNucleusProgrammingModel
+* o.a.i.persistence.jdo.datanucleus.schema.JdoSchemaService
_Dependencies_
@@ -1893,12 +1897,6 @@ Folder: \persistence\jdo\integration
----
|JDO Integration (powered by DataNucleus)
-_Components_
-
-* o.a.i.persistence.jdo.integration.jdosupport.IsisJdoSupportDN5
-* o.a.i.persistence.jdo.integration.metamodel.JdoIntegrationProgrammingModel
-* o.a.i.persistence.jdo.integration.schema.JdoSchemaService
-
_Dependencies_
* org.apache.isis.commons:isis-commons:jar:<managed>
@@ -2117,6 +2115,10 @@ Folder: \persistence\jpa\metamodel
----
|JPA Metamodel Facets / Programming Model
+_Components_
+
+* o.a.i.persistence.jpa.metamodel.JpaProgrammingModel
+
_Dependencies_
* org.apache.isis.core:isis-core-internaltestsupport:jar:<managed>
@@ -3995,7 +3997,15 @@ Artifact: isis-extensions-secman-persistence-jpa
Type: jar
Folder: \extensions\security\secman\persistence-jpa
----
-|_Dependencies_
+|_Components_
+
+* o.a.i.extensions.secman.jpa.dom.permission.ApplicationPermissionRepository
+* o.a.i.extensions.secman.jpa.dom.role.ApplicationRoleRepository
+* o.a.i.extensions.secman.jpa.dom.tenancy.ApplicationTenancyRepository
+* o.a.i.extensions.secman.jpa.dom.user.ApplicationUserRepository
+* o.a.i.extensions.secman.jpa.seed.SeedSecurityModuleService
+
+_Dependencies_
* org.apache.isis.core:isis-core-runtime:jar:<managed>
* org.apache.isis.extensions:isis-extensions-secman-api:jar:<managed>
diff --git a/core/config/src/main/adoc/modules/config/pages/sections/isis.persistence.jdo-datanucleus.impl.adoc b/core/config/src/main/adoc/modules/config/pages/sections/isis.persistence.jdo-datanucleus.impl.adoc
index 8c216cc..672a061 100644
--- a/core/config/src/main/adoc/modules/config/pages/sections/isis.persistence.jdo-datanucleus.impl.adoc
+++ b/core/config/src/main/adoc/modules/config/pages/sections/isis.persistence.jdo-datanucleus.impl.adoc
@@ -313,75 +313,6 @@ ConnectionUserName
| null
-|
-[[isis.persistence.jdo-datanucleus.impl.javax.jdo.option.connection-driver-name]]
-isis.persistence.jdo-datanucleus. +
-impl.javax.jdo.option. +
-connection-driver-name
-
-|
-| JDBC driver used by JDO/DataNucleus object store to connect.
-
-See also ``json`` (PascalCasing instead of kebab-casing).
-
-NOTE: this config property isn't used by the framework, but provided as a convenience for IDE autocomplete (and is mandatory if using JDO Datanucleus).
-
-
-|
-[[isis.persistence.jdo-datanucleus.impl.javax.jdo.option.connection-password]]
-isis.persistence.jdo-datanucleus. +
-impl.javax.jdo.option. +
-connection-password
-
-|
-| Password for the user account used by JDO/DataNucleus object store to connect.
-
-See also ``json`` (PascalCasing instead of kebab-casing).
-
-NOTE: this config property isn't used by the framework, but provided as a convenience for IDE autocomplete. It is not necessarily mandatory, some databases accept an empty password.
-
-
-|
-[[isis.persistence.jdo-datanucleus.impl.javax.jdo.option.connection-url]]
-isis.persistence.jdo-datanucleus. +
-impl.javax.jdo.option. +
-connection-url
-
-|
-| URL used by JDO/DataNucleus object store to connect.
-
-See also ``json`` (PascalCasing instead of kebab-casing).
-
-NOTE: some extensions (H2Console, MsqlDbManager) peek at this URL to determine if they should be enabled. Note that it is also mandatory if using JDO Datanucleus.
-
-
-|
-[[isis.persistence.jdo-datanucleus.impl.javax.jdo.option.connection-user-name]]
-isis.persistence.jdo-datanucleus. +
-impl.javax.jdo.option. +
-connection-user-name
-
-|
-| User account used by JDO/DataNucleus object store to connect.
-
-See also ``json`` (PascalCasing instead of kebab-casing).
-
-NOTE: this config property isn't used by the framework, but provided as a convenience for IDE autocomplete (and is mandatory if using JDO Datanucleus).
-
-
-|
-[[isis.persistence.jdo-datanucleus.impl.javax.jdo.persistence-manager-factory-class]]
-isis.persistence.jdo-datanucleus. +
-impl.javax.jdo. +
-persistence-manager-factory-class
-
-| org.datanucleus.api.jdo. +
-JDOPersistenceManagerFactory
-| See also ``json`` (camelCasing instead of kebab-casing).
-
-NOTE: changing this property from its default is used to enable the flyway extension (in combination with ``Schema#isAutoCreateAll()``
-
-
|===
diff --git a/preview.sh b/preview.sh
index 3cff4c9..ecf4332 100644
--- a/preview.sh
+++ b/preview.sh
@@ -19,7 +19,7 @@ do
forcing=true ;;
C) export SKIP_CONFIGS=false
forcing=true ;;
- W) export SKIP_PROJDOC_GENERATION=false
+ P) export SKIP_PROJDOC_GENERATION=false
forcing=true ;;
A) export SKIP_ANTORA_GENERATION=false
export SKIP_CLEAR_CACHE=false
diff --git a/scripts/ci/_adoc-gen-projdoc.sh b/scripts/ci/_adoc-gen-projdoc.sh
index eeed2c4..266511a 100644
--- a/scripts/ci/_adoc-gen-projdoc.sh
+++ b/scripts/ci/_adoc-gen-projdoc.sh
@@ -35,22 +35,35 @@ fi
MODE=projdoc
-
+GENERATED_PATH="${PROJECT_ROOT_PATH}/antora/components/system/modules/generated"
##
## run java
##
JAVA_CMD=$(command -v java)
+DOS2UNIX_CMD=$(command -v dos2unix)
echo ""
-echo "\$JAVA_CMD : ${JAVA_CMD}"
+echo "\$JAVA_CMD : ${JAVA_CMD}"
+echo "\$DOS2UNIX_CMD : ${DOS2UNIX_CMD}"
echo ""
# for now meant to run with nightly builds only
if [ -z "${JAVA_CMD}" ]; then
echo "projdoc gen: no java, skipping"
else
- java -jar "${PROJECT_ROOT_PATH}/tooling/cli/target/isis-tooling-cli.jar" -p "${PROJECT_ROOT_PATH}" -o "${PROJECT_ROOT_PATH}/antora/components/system/modules/generated" $MODE
+ java -jar "${PROJECT_ROOT_PATH}/tooling/cli/target/isis-tooling-cli.jar" -p "${PROJECT_ROOT_PATH}" -o "${GENERATED_PATH}" $MODE
+
+ if [ ! -z "${DOS2UNIX_CMD}" ]; then
+ for FILE in $(find $GENERATED_PATH -name "*.adoc" -print)
+ do
+ ${DOS2UNIX_CMD} $FILE
+ done
+ echo
+ echo
+ echo
+ fi
+
fi
diff --git a/tooling/cli/adoc/modules/tooling-cli/examples/isis-tooling.yml b/tooling/cli/adoc/modules/tooling-cli/examples/isis-tooling.yml
index 77fba0f..d3a1060 100644
--- a/tooling/cli/adoc/modules/tooling-cli/examples/isis-tooling.yml
+++ b/tooling/cli/adoc/modules/tooling-cli/examples/isis-tooling.yml
@@ -45,6 +45,9 @@ global:
Wicket: "org.apache.isis.viewer:isis-viewer-wicket.*"
Valuetypes: org.apache.isis.valuetypes.*
+ "Asciidoc": "org.apache.isis.valuetypes:isis-valuetypes-asciidoc.*"
+ "Markdown": "org.apache.isis.valuetypes:isis-valuetypes-markdown.*"
+ "SSE": "org.apache.isis.valuetypes:isis-valuetypes-ssec.*"
Mappings: org.apache.isis.mappings
#"Outbox Publisher": org.apache.isis.mappings:isis-mappings-jaxrsclient.*
@@ -56,7 +59,7 @@ global:
Extensions: org.apache.isis.extensions
"Core: Command Log": "org.apache.isis.extensions:isis-extensions-command-log.*"
"Core: Command Replay": "org.apache.isis.extensions:isis-extensions-command-replay.*"
- "Core: Flyway": "org.apache.isis.extensions:isis-extensions-flyway.*"
+ #"Core: Flyway": "org.apache.isis.extensions:isis-extensions-flyway.*"
"Core: Model Annotation": "org.apache.isis.extensions:isis-extensions-modelannotation.*"
"Core: Quartz": "org.apache.isis.extensions:isis-extensions-quartz.*"
#"Security: Audit Trail": "org.apache.isis.security:isis-extensions-audit-trail.*"
@@ -96,5 +99,5 @@ commands:
description: "These tables summarize all Maven artifacts available with _Apache Isis_."
index:
- fixOrphanedAdocIncludeStatements: true
+ fixOrphanedAdocIncludeStatements: false