Skip to content

Commit 5b12b47

Browse files
Convert AsciiDoc documentation to Markdown (#12389)
Convert AsciiDoc documentation to Markdown. The former SE content is published under the top-level Modules and Guides sections. The configuration documentation generator now outputs Markdown instead of AsciiDoc, with simpler anchor handling for included pages. Generated configuration docs are checked in under `docs/config`, and CI regenerates them and fails if the checked-in output is out of date. Aggregate Javadocs are generated by the dedicated `javadocs/pom.xml` module instead of `docs/pom.xml`.
1 parent 873c996 commit 5b12b47

1,013 files changed

Lines changed: 68572 additions & 43412 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/1_bug.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ assignees: ''
99

1010
## Environment Details
1111
* Helidon Version:
12-
* Helidon SE or Helidon MP
1312
* JDK version:
1413
* OS:
1514

@@ -24,4 +23,3 @@ assignees: ''
2423
[//]: # "Step by step instructions to reproduce the problem"
2524
[//]: # "Provide sample code/application if relevant"
2625

27-

.github/workflows/validate.yml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ jobs:
163163
artifact-path: |
164164
**/target/state-javadoc.xml
165165
**/target/*-javadoc.jar
166+
javadocs/target/*.jar
166167
run: |
167168
mvn ${MVN_ARGS} -T8 \
168169
-Dorg.slf4j.simpleLogger.showThreadName=true \
@@ -191,8 +192,19 @@ jobs:
191192
mvn ${MVN_ARGS} \
192193
-Dcache.recordSuffix=docs \
193194
-f docs/pom.xml \
194-
-Pjavadoc \
195195
install
196+
- name: Verify generated configuration documentation
197+
shell: bash
198+
run: |
199+
changes="$(git status --porcelain=v1 --untracked-files=all -- docs/config)"
200+
if [[ -n "${changes}" ]]; then
201+
echo "${changes}"
202+
git diff -- docs/config
203+
echo "::error::Generated configuration documentation is out of date."
204+
echo "Regenerate with:"
205+
echo " mvn -f docs/pom.xml generate-sources"
206+
exit 1
207+
fi
196208
examples:
197209
needs: build
198210
timeout-minutes: 30

.gitignore

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,6 @@ nb-configuration.xml
5353
.classpath
5454
.factorypath
5555

56-
# Asciidoctor
57-
.asciidoctor/
58-
5956
# Vim
6057
*.swp
6158

@@ -83,7 +80,7 @@ ObjectStore/
8380
PutObjectStoreDirHere/
8481
package-lock.json
8582
RUNTIMEDB/
86-
docs/se/config/images
83+
docs/modules/config/images
8784
.helidon-oidc-secret
8885
.helidon-oidc-secret.*.tmp
8986

.mvn/cache-config.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<lifecycleConfig>
2222
<project path="docs/pom.xml">
2323
<projectFilesExcludes>
24-
<exclude>src/main/asciidoc/config/*</exclude>
24+
<exclude>config/*</exclude>
2525
</projectFilesExcludes>
2626
</project>
2727
<project glob="**/*">

CONTRIBUTING.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ When filing a bug remember that the better written the bug is, the more likely i
1414
to be fixed. Please include:
1515

1616
1. Version of Helidon
17-
2. Whether you are writing a Helidon SE or MP application
18-
3. OS
19-
4. Version of Docker or Kubernetes or other software if it's relevant to your issue
20-
5. Steps to reproduce
17+
2. OS
18+
3. Version of Docker or Kubernetes or other software if it's relevant to your
19+
issue
20+
4. Steps to reproduce
2121

2222
## Contributing Code
2323

@@ -41,4 +41,3 @@ first.
4141
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If
4242
you'd like more specific guidelines see the
4343
[Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
44-

DEV-GUIDELINES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ be used by users to [bom/pom.xml](bom/pom.xml).
337337

338338
- <a id="rule-11-6-1"></a>**Rule 11.6.1.** Avoid bundling third-party dependencies that may add unexpected libraries,
339339
such as the Google Login provider.
340-
- <a id="rule-11-6-2"></a>**Rule 11.6.2.** Put SE bundles under `bundles/` with group ID `io.helidon.bundles`.
340+
- <a id="rule-11-6-2"></a>**Rule 11.6.2.** Put Helidon bundles under `bundles/` with group ID `io.helidon.bundles`.
341341
- <a id="rule-11-6-3"></a>**Rule 11.6.3.** Keep bundle directories scoped to active Helidon bundle families.
342342
- <a id="rule-11-6-4"></a>**Rule 11.6.4.** Bundles are for end users, not internal use.
343343

0 commit comments

Comments
 (0)