Skip to content

Doc: add a "please use dev version" to top of contribute docs #27386

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

Merged
merged 1 commit into from
Nov 30, 2023

Conversation

story645
Copy link
Member

@story645 story645 commented Nov 28, 2023

PR summary

Motivated by a top issue for new contributors being that they're not using the dev docs. xref #18402
So I tried to version guard this so the admonishment will only show on non devel versions but I don't think I can test if this works on non-backports. Aim is it looks like this

image

PR checklist

@story645 story645 added the Documentation: devdocs files in doc/devel label Nov 28, 2023
@story645 story645 added this to the v3.8-doc milestone Nov 28, 2023
@jklymak
Copy link
Member

jklymak commented Nov 28, 2023

Would it be better if we just redirected the contribute page to the dev docs?

@story645
Copy link
Member Author

story645 commented Nov 28, 2023

Probably yes (#18402) but that got tangled up w/ extracting the version independent docs #22866 & this is at least a quick fix

ETA: On #22866, it was waiting on the overhaul of devdocs/ripping out of gitwash, and that's been basically done. I'm trying to more or less close out big changes to the devdocs organization w/ #27265 - I still would like to get Noa's triage docs in, but I don't think that's a blocker.

@story645
Copy link
Member Author

story645 commented Nov 28, 2023

So thinking about broad redirects, should dependencies then be moved out to /install and cross linked? B/c it is version dependent for runtime + building non-editable from source?

@QuLogic QuLogic merged commit 88e4a43 into matplotlib:main Nov 30, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Nov 30, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Nov 30, 2023
oscargus added a commit that referenced this pull request Nov 30, 2023
…386-on-v3.8.x

Backport PR #27386 on branch v3.8.x (Doc: add a "please use dev version" to top of contribute docs)
oscargus added a commit that referenced this pull request Nov 30, 2023
…386-on-v3.8.2-doc

Backport PR #27386 on branch v3.8.2-doc (Doc: add a "please use dev version" to top of contribute docs)
@story645 story645 deleted the contrib-admonishment branch November 30, 2023 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: devdocs files in doc/devel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants