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

MAINT: Archive old doc versions #11885

Closed
larsoner opened this issue Aug 15, 2023 · 3 comments · Fixed by #11888
Closed

MAINT: Archive old doc versions #11885

larsoner opened this issue Aug 15, 2023 · 3 comments · Fixed by #11888
Milestone

Comments

@larsoner
Copy link
Member

We currently have a version drop-down all the way to 0.11, which I think is rarely used or completely unused. Also when pushing commits to mne-tools.github.io repo I get warnings like this that suggest that our HTML has vulnerabilities, which is presumably due to ancient webpages:

remote: GitHub found 16 vulnerabilities on mne-tools/mne-tools.github.io's default branch (16 moderate). To find out more, visit:
remote:      https://github.com/mne-tools/mne-tools.github.io/security/dependabot

I suggest we put some lower bound on which versions to archive -- maybe the last 2 years worth of versions? This should help reduce this security issue, and also make the site faster to deploy and fetch, etc. If we don't want to get rid of the 0.11 docs entirely for example we could archive them in a .zip and link to them somewhere in our docs. This could easily be added as another step in our release process, and I don't think it would take too much extra time/effort (< 10 min) during release time.

Any objections? @drammock I'm releasing today but can take care of the changes this week and backport them to the maint/1.5 branch I'm going to make (so that links to the archived versions exist).

@larsoner larsoner added this to the 1.6 milestone Aug 15, 2023
@drammock
Copy link
Member

crossref: #10932

I can't think of a good reason to keep the very old website versions available online. It would be nice if they existed somewhere --- could we have a separate branch of the mne-tools.github.io where we store all versions and then main can just have N versions?

maybe the last 2 years worth of versions?

2 years would go back to 0.23, 3 years would include back to 0.21.

My feeling is that things are starting to stabilize and the package is maturing, which means people may become less likely to habitually update all the time, which means installs of a particular version might hang around for longer, so it might be good to preserve 3 years worth of docs instead of 2.

@larsoner
Copy link
Member Author

It would be nice if they existed somewhere --- could we have a separate branch of the mne-tools.github.io where we store all versions and then main can just have N versions?

I was thinking we'd just create archives like mne.tools/0.15.zip and link to them in a bulleted list from somewhere in our docs. We could maybe access a new "Old docs" page from a older... dropdown entry in the versions.json that just takes you to the "Old docs" webpage with links to these zip archives. This seems very easy to maintain from our end but easy for people to download, unzip, and view if they really want to.

@drammock
Copy link
Member

adding an older... dropdown to the version switcher sounds nice, though off the top of my head I'm not sure it will work out-of-the-box (as a new entry in the .json file) or if we'll need custom javascript to append to the list after the versions are populated.

For now let's ZIP and we can worry about adding access to the ZIPs at a (not too much) later date... unless you already have a clear idea where this page should live, in which case go for it.

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 a pull request may close this issue.

2 participants