Skip to content

WIP: Add Versions

Connor Shea requested to merge add-versions into master

This adds versioning to the documentation site so users can view documentation for older versions of our products.

Checklist:

  • Add versions
  • Make it generate as fast as possible (this has been mostly solved by adding caching and using a static version of the header items)
  • Make it more obvious that users can switch between versions
  • Make it more obvious what version a user is currently viewing
  • Make it easier to understand what version "stable" refers to, e.g. "Stable (8.14)" (maybe add a "vanity name" attribute to the YAML for each version instead of using the URL)
  • Figure out SEO (maybe we shouldn't let search engines index anything other than stable by blocking it with the robots.txt?)
  • Figure out search (May require switching to Algolia #21 (closed))
  • Figure out how to redirect existing pages to their "stable" versions
  • Make it easy to update with new versions of the products (e.g. add some instructions to the README, a Rake task probably isn't possible (?))
  • Figure out how to handle comments on different versions of the same page
  • OPTIONAL FOR THIS MR: Build an "archive" site for older versions, allowing us to build the site without it taking super long as we add more and more versions while also not dropping support for older versions of the site

See #16 (closed).

Merge request reports