Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build antora docs (main branch) #722

Merged
merged 10 commits into from
Mar 10, 2024

Conversation

abelsromero
Copy link
Member

@abelsromero abelsromero commented Mar 5, 2024

  • Moved docs to an Antora structure under '/docs'

    • Created antora.yaml
    • Added nav.adoc respecting current structure.
    • Created modules 'ROOT' and 'apendices'
    • Moved source files to respective modules
    • Updated section level (reduced in 1)
    • Created soft link to include content from project sources
  • Cleaned README.adoc

    • Removed un-used attributes
    • Updated content
  • Removed now unnecessary elements:

    • Gradle docs modules
    • 'push-documentation' GH Action
  • Fixes:

    • Fixed invalid references (I am not upgrading all references from legacy to modern in this PR)
    • Several typos & formatting

ℹ️ Outside of the PR I renamed development-v3.x branch to maintenance-3.x, to align with the documentation done prior to my changes.

- use release-version instead of revnumber to prepare Antora
- use level-0 depth level to prepare Antora
- several fixes
@abelsromero abelsromero force-pushed the build-antora-docs branch 2 times, most recently from b46054e to 186074a Compare March 9, 2024 20:36
@abelsromero abelsromero changed the title Build antora docs Build antora docs (main branch) Mar 9, 2024
@abelsromero abelsromero marked this pull request as ready for review March 9, 2024 21:04
@abelsromero abelsromero force-pushed the build-antora-docs branch 2 times, most recently from b310e7c to b2678c7 Compare March 10, 2024 21:09
@abelsromero abelsromero merged commit 75b9168 into asciidoctor:master Mar 10, 2024
3 checks passed
tylerbertrand pushed a commit to tylerbertrand/asciidoctor-gradle-plugin that referenced this pull request Apr 12, 2024
* Moved docs to an Antora structure under '/docs'
  * Created antora.yaml
  * Added nav.adoc respecting current structure.
  * Created modules 'ROOT' and 'apendices'
  * Moved source files to respective modules
  * Updated section level (reduced in 1)
  * Created soft link to include content from project sources
 
* Cleaned README.adoc
  * Removed un-used attributes
  * Updated content
* Removed now unnecessary elements:
  * Gradle docs modules
  * 'push-documentation' GH Action
* Fixes:
  * Fixed invalid references (I am not upgrading all references from [legacy to modern](https://docs.asciidoctor.org/asciidoc/latest/sections/custom-ids/) in this PR)
  * Several typos & formatting
Outside of the PR I renamed development-v3.x branch to maintenance-3.x, to align with the documentation done prior to my changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant