DO NOT MERGE! Versioned Documentation on the website#9262
Draft
espy wants to merge 13 commits into
Draft
Conversation
Surprisingly tricky, since the navigations are versioned, but the layout that includes it and the nav items they in turn include are _not_.
…be set up to use it
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Important
Ahoi! ✋ This PR only contains the technical implementation, there is additional editorial work to do. Since we do not want to deploy just the tech bit, this PR should not be merged until the versioned pages have been revised. More info below.
This website PR allows us to publish versioned docs, like CouchDB does too. This means that the following parts of the website can change depending on the selected PouchDB version, and have a version switcher in the bottom right so users can directly switch between, say, the sync docs for
8.0.0and the sync docs for9.0.0with a single click:Screenshots at the end of this PR.
The setup is:
latest. Each of these containGuides,APIandLearn, and their respective sidebar navs, where applicable.docs/_data/site.jsfile that defines the available versions and which one of them isstablestablelatestfolder, and when the next release is made, that folder is duplicated and renamed to whatever that release’s version is.Navigation:
stable.prevandnextbuttons, stay within that selected version.stableversioned pages that the user is currently looking at out-of-date docs.The PR also adds a
WEBSITE_README.mdto provide more details on the workflow and the 11ty setup used to make this possible.Testing recommendations
Run locally with
npm run build-siteand test all the nav items. I've explicitly not gone over the links in the text on the versioned pages, since we’ll probably want to edit those.Warning
If the site doesn’t build after checking out this branch, delete your build folder at
/docs/_siteand try againRemaining editorial work
I’ve currently set this up to have versioned docs for
7.3.0,8.0.0and9.0.0.8.0.0is when we added purge and activeTasks, and9.0.0was just generally a lot of changes. I see7.3.0as a historical starting point we could just mostly leave as-is, and the other two as worth updating. We could also opt to not bother with any of this, just start at9.0.0and pretend the past never happened.If we do proceed with these three versions, we need to:
7.3.0section work: the internal ones should point to the respective7.3.0pages, and all external links should be reviewed to see whether their targets still exist. Some of these are over a decade old. I've already made sure this version does not have docs forpurgeoractiveTasks, but made no other content changes.8.0.0pages’ content through the board, including external references, plugin info, compatibility info, about pages, guides, which tutorial videos we link to/embed… all of it.8.0.0pages as the basis for the9.0.0pages.For this work, I suggest making PRs against this branch.
Related Issues or Pull Requests
This is the final puzzle piece for #9246
Checklist
docsfolder