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

Patch Antora directories only #58

Merged
merged 1 commit into from
Jan 10, 2024
Merged

Conversation

alandefreitas
Copy link
Member

@alandefreitas alandefreitas commented Jan 10, 2024

Changes the release script to only patch libs with directories from the Antora documentation.

This means libs won't be patched with files from the Antora build dir, such as 404.html, robots.txt, and sitemap.xml, as these are the responsibility of the boost website. Antora also used to generate and need a search-index.js file but that's been already removed in boostorg/website-v2-docs@fc1bd39.

The only problem left is _ in libs. We're discussing a solution to that.

Related to #57.

@alandefreitas
Copy link
Member Author

alandefreitas commented Jan 10, 2024

We're discussing a solution to that.

Considering the antora directory layout, the solutions proposed so far were for the _ directory:

  • Keep patching Antora into libs and leave _ in libs as part of Antora support. Cons: _ could be considered a library by some script.
  • Find another directory for Antora documentation (where?) and copy all Antora docs to this new directory. Libraries using antora would update their index.html files to redirect there. Pros: when moving to Antora, libraries could temporarily access both documentation folders on boost.org before removing the old scripts. Cons: Links to documentation would change considerably.
  • Move _ somewhere else (where?) and include a workaround to patch all files in Antora HTML files replacing ../_ with a relative reference to this new directory. Cons: huge unstable workaround.

@sdarwin
Copy link
Contributor

sdarwin commented Jan 10, 2024

There are a list of proposals here. Let me know if I can merge the existing update.

@alandefreitas
Copy link
Member Author

There are a list of proposals here. Let me know if I can merge the existing update

The update in this PR is independent of the proposals. This PR is improving what we have. The proposals are about the _ directory, which this PR doesn't fix.

@sdarwin sdarwin merged commit bbeab6e into boostorg:develop Jan 10, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants