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

Antora 3.1 upgrade #4929

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Antora 3.1 upgrade #4929

merged 1 commit into from
Jan 30, 2024

Conversation

mmattel
Copy link
Contributor

@mmattel mmattel commented Jan 12, 2024

References: owncloud/docs-client-branding#90 (Antora 3.1 upgrade)
Fixes: #4853 (Upgrade the documentation framework)
Fixes: #4545 (Antora release upgrade from 2.3.4 to 3.0.x)

This upgrades Antora to version 3 (3.1.7 atm).

Tasks:

  • Updating package.json so it has the latest Antora (3.1.7 atm)
  • Updating package.json to use the correct options for the Antora builds
  • Re-integrate search into the build process
    No more using an own generator, but creating a extension listening to an Antora event
  • Fix search to only run when really required. The formerly used BUILD_SEARCH_INDEX triggered the indexing preperation step
  • Removig the xref-validator js code as this is now fully covered in the Antora build process,
    see https://gitlab.com/antora/xref-validator
  • Removing the xref-validator step from the pipeline
  • Removing the generator directory as it is empty now
  • Removing Edit-this-page js code from the generation code as this is now handled by Antora,
    see https://docs.antora.org/antora/latest/playbook/content-edit-url/#source-view
  • Remove all old pdf generating supporting scripts in bin/
    linter, instructions_makepdf.md, makepdf, manual_config_pdf
  • Removing the docs-pdf step from the pipeline (not applicapable)
  • Commenting the uploading pdf step in .drone.star (not applicapable)
  • Harmonize directory names for each extension (antora, asciidoc) + setting it correctly in site.yml
  • Fix asciidoctor-kroki extension registration in site.yml
  • Force cheerio to use the htmlparser2 engine - 6x more performant
    This will take much less time in CI to finish the job freeing ressources - for EACH docs build
  • Upgrade the pipeline to Node 18 as Node 16 is already EOL

Other repo dependent important notes/steps:

  • All failing xrefs need to be resolved first - none as we do not have any modules/components here and all other repos have been prepared already.
  • For the docs repo, we can remove BUILD_SEARCH_INDEX from .drone.star as it is no longer used.
    "BUILD_SEARCH_INDEX": ctx.build.branch == deployment_branch, --> remove.
  • Need a docs repo upgrade for Node 18 and a comment that one needs to upgrade his local installation!

Upgrade sort order:

  • docs-server + branches
  • docs-client-desktop + branches
  • docs-client-android + branches
  • docs-client-ios-app + branches
  • docs-branding
  • docs-webui
  • docs-ocis
  • docs-main
  • docs

@mmattel mmattel added deployment Tasks relating to deploying the documentation dependencies Pull requests that update a dependency file labels Jan 12, 2024
@mmattel mmattel force-pushed the test_antora_3.1_upgrade branch 2 times, most recently from feb3b77 to 930af93 Compare January 29, 2024 12:21
@mmattel mmattel marked this pull request as ready for review January 30, 2024 10:54
@mmattel mmattel merged commit 5bc7a8a into master Jan 30, 2024
1 check passed
@mmattel mmattel deleted the test_antora_3.1_upgrade branch January 30, 2024 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file deployment Tasks relating to deploying the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Upgrade the documentation framework Antora release upgrade from 2.3.4 to 3.0.x
3 participants