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

Investigate how to keep old doc versions in the website without building them on every build. #781

Open
djencks opened this issue Feb 9, 2022 · 0 comments

Comments

@djencks
Copy link
Contributor

djencks commented Feb 9, 2022

It would be great to keep all the old doc versions accessible in our website:

  • links from old blog posts would keep working
  • external links would keep working
  • Someone stuck on an old version could find the docs

However...

  • building an ever growing set of doc versions on every build will soon take too long to be practical
  • Without a way to hide obsolete doc versions, the component explorer will become unwieldy

In any case, I believe we have to rebuild the entire site when the UI changes or Antora is significantly upgraded.

At the moment we are using the standard Antora component explorer, which includes the whole explorer in every page. There are other solutions such as putting this stuff in a separate json document and rendering the json on each page. If we stick with the default component explorer I think we have to rebuild the entire site whenever we add a doc version, so the explorer on old pages can get to all versions.

For all other site builds, I think it should be possible to do something using a site manifest similar to the subproject-specific partial doc builds to only build "active" doc branches while using the already-built pages for the "inactive" doc branches. Together with setting up the partial builds, we'll need to figure out how to publish a complete site when only part of it has been "just built". Either we have to remove only the "old, active" pages when publishing the site, or find an independent way to archive the inactive pages and add them to the "built site" before committing.

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

No branches or pull requests

1 participant