Skip to content

Disable edit links in non-maintained versions #1407

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

Closed
debadair opened this issue Nov 14, 2019 · 2 comments
Closed

Disable edit links in non-maintained versions #1407

debadair opened this issue Nov 14, 2019 · 2 comments
Labels
docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo. enhancement Something we'd like to improve

Comments

@debadair
Copy link
Contributor

Currently, the edit links show up for all pages in all versions if the source is in a public repo. This leads to PRs being opened against versions that we otherwise wouldn't touch. Those fixes often get "lost" because they aren't forward ported, and forward porting them is difficult due to the constant evolution of the docs.

The simplest option is to remove the edit button for select versions of a book. Trying to redirect to current/master/whatever doesn't work for the same reasons that forward porting is non-trivial.

We could leave the edit buttons and pop up a message that asks the user to open a PR against master, but I'm not sure that's much friendlier than removing the edit button entirely. (Because using the version picker to switch to master might just get you the "This page is not available in the docs for version:master" message.)

We might want to consider changing the default "You are looking at documentation for an older release" message to explicitly state that the version is no longer being updated

@debadair debadair added enhancement Something we'd like to improve docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo. labels Nov 14, 2019
@zuketo
Copy link

zuketo commented Nov 18, 2019

+1, I like the proposal to remove the edit button completely for non-maintained/EOL versions. I also like the idea of using stronger language in the top message. A competitor uses the wording "This version of the manual is no longer supported." for EOL versions, maybe something along those lines?

@nik9000
Copy link
Member

nik9000 commented Feb 21, 2020

Closed by #1533.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo. enhancement Something we'd like to improve
Projects
None yet
Development

No branches or pull requests

3 participants