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

Show message to users when accessing an old version of the documentation #76

Closed
kd-ods opened this issue May 1, 2018 · 5 comments
Closed
Labels
sphinx For updates to documentation generation

Comments

@kd-ods
Copy link
Collaborator

kd-ods commented May 1, 2018

I assume we'll have a message like the one on OCDS docs when people get to legacy pages?

@Bjwebb
Copy link
Collaborator

Bjwebb commented May 10, 2018

This isn't going to happen automatically, so we'll need to put some thought into how we do this (particularly since the particular mechanism used for the OCDS docs isn't available on ReadTheDocs.

@timgdavies timgdavies changed the title Checking plans re versioning docs Show message to users when accessing an old version of the documentation Mar 23, 2020
@timgdavies timgdavies added the sphinx For updates to documentation generation label Mar 23, 2020
@timgdavies
Copy link
Contributor

As part of our next release of the standard we should consider moving to deployment on OpenOwnership servers, along the same model used for OCDS.

This would allow the same mechanism to be used.

@odscjames
Copy link
Collaborator

I don't think this is enough of a reason to undertake the big work of moving to our own servers (maybe there are other reasons to do this of course, but not this in itself).

I previously handled this manually.

Every release is a branch in git, not a tag. This allows non-standard changing things to be added to a standard release after that release is made, such as - a banner saying this is old.

If you look at https://github.com/openownership/data-standard/commits/v0-0-3 it has 2 commits that master does not have - the first to solve a technical issue and the second to add a banner saying it's old.

We can do this for 0.1 now (which is missing it) and 0.2, when the time comes.

@stevenday stevenday added this to the 1.0 Release Candidate milestone Jul 16, 2020
@jpmckinney
Copy link

@kd-ods
Copy link
Collaborator Author

kd-ods commented Nov 9, 2021

Closing this so that we track this work on one place. On: openownership/data-standard-sphinx-theme#67.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sphinx For updates to documentation generation
Projects
None yet
Development

No branches or pull requests

6 participants