Repository navigation
redirect contribute to dev version #18402
Description
Problem
Many new contributors start at either https://matplotlib.org/devel/index.html or https://matplotlib.org/users/installing.html and often end up installing the latest release rather than the dev release from master.
Suggested Improvement
these were both proposed on today's GSOD call:
- redirect the contribute button on the homepage to https://matplotlib.org/devdocs/devel/index.html & add language about checking out https://matplotlib.org/ docs when developing
- Add a link/obnoxious banner to the dev docs on https://matplotlib.org/devel/index.html
Activity
rajpratyush commented on Mar 16, 2021
@story645 could not understand this?
QuLogic commented on Mar 16, 2021
This issue is a bit outdated, as we probably want to move contributing docs to https://github.com/matplotlib/mpl-brochure-site/ instead.
story645 commented on Mar 16, 2021
I thought they were getting moved to a third contribute-docs repo, but yeah this might be questionably actionable.
@rajpratyush yeah sorry incomplete link there, I meant folks should check the development version of the docs at dev.matplotlib.org before putting in a doc pr
rajpratyush commented on Mar 16, 2021
@story645 So the solutions for this issue could be :
we need to explicitly mention the contributors to install the dev version rather than latest release.
redirect the contribute button on the homepage to https://matplotlib.org/devdocs/devel/index.html
Add a link to the dev docs on https://matplotlib.org/devel/index.html
Tell the developers to check the development version of the docs at dev.matplotlib.org before putting in a doc PR.
story645 commented on Mar 16, 2021
Sounds like a reasonable plan.
Going by @QuLogic's comment, is more that this issue is maybe stalled until we decide what we're doing w/ the contributing guide, but I think most of the proposed changes would carry over to a moved contribute guide anyway (especially the thing about docs).
rajpratyush commented on Mar 16, 2021
@story645 that was my one of the concerns that this issue maybe stale for a while. When do you think the work on this will begin?
story645 commented on Aug 12, 2022
closing in favor of #22866 and the rest of the action items have been incorporated into docs/templates
story645 commented on Jan 22, 2025
this was closed with matplotlib/matplotlib.org#36