This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/causeway.git
The following commit(s) were added to refs/heads/master by this push:
new 52f2d091af CAUSEWAY-3712: updates tooling site docs
52f2d091af is described below
commit 52f2d091af266adae0e0045d71b597918937c7e8
Author: andi-huber <[email protected]>
AuthorDate: Mon Apr 1 13:58:22 2024 +0200
CAUSEWAY-3712: updates tooling site docs
---
.../modules/ROOT/pages/cutting-a-release.adoc | 1 +
.../ROOT/pages/post-release-successful.adoc | 1 +
.../modules/ROOT/pages/updating-the-website.adoc | 1 +
.../ROOT/pages/building-apache-causeway.adoc | 7 ++--
.../conguide/modules/documentation/nav.adoc | 1 -
.../modules/documentation/pages/about.adoc | 2 +-
.../modules/documentation/pages/tooling.adoc | 39 ----------------------
.../components/docs/modules/ROOT/pages/about.adoc | 1 -
.../ROOT/partials/module-nav/framework.adoc | 1 -
antora/playbooks/site.NEXT.yml | 8 -----
antora/playbooks/site.yml | 8 -----
causeway-tooling.yml | 1 -
scripts/ci/_adoc-gen-projdoc.sh | 2 +-
13 files changed, 7 insertions(+), 66 deletions(-)
diff --git
a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
index 9e31761773..5c2480489e 100644
--- a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
@@ -164,6 +164,7 @@ The next step is to generate the website, ensuring that the
config, examples, pr
+
[source,bash,subs="attributes+"]
----
+#TODO this is outdated info
mvnd -D module-tooling -D skip.essential install -DskipTests -T1C
----
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 81697170f7..8a24a4f5b3 100644
--- a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc
@@ -364,6 +364,7 @@ popd
+
[source,bash,subs="attributes+"]
----
+#TODO this is outdated info
mvnd -D module-tooling -D skip.essential install -DskipTests
----
+
diff --git
a/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc
b/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc
index fd08dd6364..01eee4cf43 100644
--- a/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/updating-the-website.adoc
@@ -32,6 +32,7 @@ git checkout {page-causewayrel}
+
[source,bash,subs="attributes+"]
----
+#TODO this is outdated info
mvn -D module-tooling -D skip.essential install -DskipTests
----
diff --git
a/antora/components/conguide/modules/ROOT/pages/building-apache-causeway.adoc
b/antora/components/conguide/modules/ROOT/pages/building-apache-causeway.adoc
index f140861896..a22d48077e 100644
---
a/antora/components/conguide/modules/ROOT/pages/building-apache-causeway.adoc
+++
b/antora/components/conguide/modules/ROOT/pages/building-apache-causeway.adoc
@@ -251,17 +251,14 @@ Note that this also includes the Restful Objects and
GraphQL viewers.
| module-regressiontests
| Regression Tests (for the CI pipelines)
-| module-tooling
-| Tooling Ecosystem (Code Mining, Automated Docs, ...)
-
|===
You can also skip building the "essential" modules that are released, by
adding the `-Dskip.essential`.
-For example, to just build the tooling module, use:
+For example, to just build the xxx module, use:
[source,bash]
----
-mvn clean install -Dmodule-tooling -Dskip.essential
+mvn clean install -Dmodule-xxx -Dskip.essential
----
diff --git a/antora/components/conguide/modules/documentation/nav.adoc
b/antora/components/conguide/modules/documentation/nav.adoc
index b4b82332fe..189d81fe67 100644
--- a/antora/components/conguide/modules/documentation/nav.adoc
+++ b/antora/components/conguide/modules/documentation/nav.adoc
@@ -3,6 +3,5 @@
* xref:conguide:documentation:about.adoc[Documentation]
** xref:conguide:documentation:building-docs-and-website.adoc[Building Docs
and Website]
-** xref:conguide:documentation:tooling.adoc[Tooling]
** xref:conguide:documentation:asciidoc-syntax.adoc[AsciiDoc Syntax]
diff --git a/antora/components/conguide/modules/documentation/pages/about.adoc
b/antora/components/conguide/modules/documentation/pages/about.adoc
index eb8f0e2a1f..ba6e2408e2 100644
--- a/antora/components/conguide/modules/documentation/pages/about.adoc
+++ b/antora/components/conguide/modules/documentation/pages/about.adoc
@@ -14,7 +14,7 @@ HTML is the format generated by Antora, but other outputs
such as PDF are also s
Details of installing Antora and building the website/documentation can be
found xref:building-docs-and-website.adoc[here].
Some of the documentation is automatically generated from the code itself.
-Details on these generators is described on the xref:tooling.adoc[tooling]
page.
+Details on these generators is described on the causewaystuff tooling.
diff --git
a/antora/components/conguide/modules/documentation/pages/tooling.adoc
b/antora/components/conguide/modules/documentation/pages/tooling.adoc
deleted file mode 100644
index cd94f3dd4e..0000000000
--- a/antora/components/conguide/modules/documentation/pages/tooling.adoc
+++ /dev/null
@@ -1,39 +0,0 @@
-= Tooling
-
-: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 [...]
-
-The `tooling` modules provides a set of utilities and generators that are used
to reduce the maintenance cost of documentation and the
link:https://github.com/apache/causeway-app-referenceapp[reference app].
-None of these modules are formally released as part of the framework.
-
-Broadly speaking there are two main sets of tools:
-
-* the `causeway-tooling-cli` module (in `tooling/cli`) creates a CLI jar file
(`causeway-tooling-cli.jar`) that is used to generate two different sets of
documentation for the website:
-
-** under `antora/components/refguide-index`
-+
-are the index pages.
-Typically API classes are included in the index, and this is done by simply
including:
-+
-[source]
-----
-@since {@index}
-----
-+
-within their javadoc.
-Learn more about how to reference these generated pages in our internal
xref:core::about.adoc#generated-index[design docs].
-
-** under `core/adoc`
-+
-is an overview of all of the modules that make up the framework.
-This can be found at xref:core:_overview:about.adoc[].
-
-+
-For more on the CLI, see xref:tooling:tooling-cli:about.adoc[tooling CLI] docs.
-You could also inspect the `preview.sh` script (and the various scripts it
calls in turn) to see how we use the CLI in practice.
-
-* the `causeway-tooling-metaprog` module (in tooling/metaprog`) contains a set
of test classes that are used to generate classes and files for the various
datatypes showcased in the
link:https://github.com/apache/causeway-app-referenceapp[reference app].
-+
-To use, locate the `ValueTypeGenTemplateTest` class.
-
-
-
diff --git a/antora/components/docs/modules/ROOT/pages/about.adoc
b/antora/components/docs/modules/ROOT/pages/about.adoc
index e2054912d8..3a997a773e 100644
--- a/antora/components/docs/modules/ROOT/pages/about.adoc
+++ b/antora/components/docs/modules/ROOT/pages/about.adoc
@@ -150,7 +150,6 @@ _Interim Builds_
_Process_
* *xref:comguide:ROOT:about.adoc[Committers' Guide]*
-* xref:tooling:ROOT:about.adoc[Tooling]
_Automated Analysis_
diff --git
a/antora/components/docs/modules/ROOT/partials/module-nav/framework.adoc
b/antora/components/docs/modules/ROOT/partials/module-nav/framework.adoc
index a76d4773ca..3fe2d0c21f 100644
--- a/antora/components/docs/modules/ROOT/partials/module-nav/framework.adoc
+++ b/antora/components/docs/modules/ROOT/partials/module-nav/framework.adoc
@@ -7,7 +7,6 @@
** Process
*** xref:comguide:ROOT:about.adoc[Committers' Guide]
-*** xref:tooling:ROOT:about.adoc[Tooling]
** Automated Analysis
*** link:https://sonarcloud.io/dashboard?id=apache_causeway[SonarCloud.io]
diff --git a/antora/playbooks/site.NEXT.yml b/antora/playbooks/site.NEXT.yml
index a2776e16e4..1398102547 100644
--- a/antora/playbooks/site.NEXT.yml
+++ b/antora/playbooks/site.NEXT.yml
@@ -244,14 +244,6 @@ content:
start_path: testing/unittestsupport/adoc # testing
branches: [2.0.0, 3.0.0]
-# tooling
- - url: .
- start_path: tooling/adoc # toc
- branches: [2.0.0, 3.0.0]
- - url: .
- start_path: tooling/cli/adoc # cli
- branches: [2.0.0, 3.0.0]
-
# valuetypes
- url: .
start_path: valuetypes/adoc # valuetypes
diff --git a/antora/playbooks/site.yml b/antora/playbooks/site.yml
index 13df002481..e9503d84d7 100644
--- a/antora/playbooks/site.yml
+++ b/antora/playbooks/site.yml
@@ -244,14 +244,6 @@ content:
start_path: testing/unittestsupport/adoc # testing
branches: HEAD
-# tooling
- - url: .
- start_path: tooling/adoc # toc
- branches: HEAD
- - url: .
- start_path: tooling/cli/adoc # cli
- branches: HEAD
-
# valuetypes
- url: .
start_path: valuetypes/adoc # valuetypes
diff --git a/causeway-tooling.yml b/causeway-tooling.yml
index 198da32a78..67ebeb2bdc 100644
--- a/causeway-tooling.yml
+++ b/causeway-tooling.yml
@@ -74,7 +74,6 @@ commands:
#"Wicket Viewer: Gmap3":
"org.apache.causeway.security:causeway-extensions-gmap3.*"
"Wicket Viewer: SSE":
"org.apache.causeway.security:causeway-extensions-sse.*"
- "Tooling": org.apache.causeway.tooling.*
"Regression Tests": org.apache.causeway.regressiontests.*
Incubator: org.apache.causeway.incubator
diff --git a/scripts/ci/_adoc-gen-projdoc.sh b/scripts/ci/_adoc-gen-projdoc.sh
index 27721105c0..3dfb0dddbf 100644
--- a/scripts/ci/_adoc-gen-projdoc.sh
+++ b/scripts/ci/_adoc-gen-projdoc.sh
@@ -51,7 +51,7 @@ echo ""
if [ -z "${JAVA_CMD}" ]; then
echo "projdoc gen: no java, skipping"
else
- JARFILE="causeway-tooling-cli.jar"
+ JARFILE="causewaystuff-tooling-cli.jar"
java -jar "${PROJECT_ROOT_PATH}/tooling/cli/target/$JARFILE" -p
"${PROJECT_ROOT_PATH}" -w "${OVERVIEW_PATH}" -x "${INDEX_PATH}" $MODE
fi
