FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

DOC: reorganizing contributing docs to clean up toc, better separate topics by story645 · Pull Request #27265 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

DOC: reorganizing contributing docs to clean up toc, better separate topics - #27265

Merged
timhoffm merged 3 commits into
matplotlib:mainfrom
story645:dev_shuffle
Dec 20, 2023
ConversationCommits (3)ChecksFiles changed
Merged

DOC: reorganizing contributing docs to clean up toc, better separate topics#27265
timhoffm merged 3 commits into
matplotlib:mainfrom
story645:dev_shuffle

Conversation

story645 commented Nov 3, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

This is in the vein of #26196 and the high level improvement is that via reorganizing:

  • top card of the contribute landing page == roadmapped index into contribute.rst

  • each card in the policies and guidelines page is now a toctree:

Also much better left hand side since I understand how to make those now thanks to @jklymak (yes it took me this long to sort out that LHS goes by toctrees, like RHS goes by headers):

The other changes are:

PR summary

PR checklist

story645 added the Documentation: devdocs files in doc/devel label Nov 3, 2023
story645 added this to the v3.8-doc milestone Nov 5, 2023
story645 force-pushed the dev_shuffle branch 2 times, most recently from c283644 to 9053d14 Compare November 5, 2023 19:27
story645 mentioned this pull request Nov 5, 2023
Open
7 of 11 tasks
story645 force-pushed the dev_shuffle branch 3 times, most recently from 3c30056 to 3be520a Compare November 6, 2023 20:10
story645 mentioned this pull request Nov 6, 2023
Closed
story645 force-pushed the dev_shuffle branch 3 times, most recently from dc5d794 to 6522557 Compare November 6, 2023 22:30
This was referenced Nov 28, 2023
Open
Merged
melissawm reviewed Dec 8, 2023
View reviewed changes
Comment thread doc/devel/api_changes.rst
melissawm reviewed Dec 8, 2023
View reviewed changes
Comment thread doc/devel/pr_guide.rst

story645 commented Dec 10, 2023 •
edited
Loading

Copy link
Copy Markdown
Member Author

Just want to mention that the only new content here is the documentation and coding section of the contribute guide & I'm not super attached to the language, I just wanted some content there to establish that the scope of that page is supposed to be introductory background/context setting/roadmapping for contributing and that other pages are where they can find the coding/doc/etc guides.
Also addresses part of this discussion #22866 (comment)

story645 commented Dec 11, 2023

Copy link
Copy Markdown
Member Author

@timhoffm you might want to skim this since I move around the API guidelines a bit, but I don't change any guidelines. The changes I made specifically are:

  • moved coding guidelines out of contribute.rst and into coding_guidelines so that the page can be scoped to just coding guidelines.
  • moved API changes guidelines into its own page b/c it is as long as every other section of the coding guide->my goal here is that it is a sort of standalone/self contained part of the guide, so making it its own page keeps it from overwhelming the rest of the coding guide.
  • moved PR guidelines into it's own page b/c those guidelines apply to code and docs. My aim is also to reduce duplication between PR guidelines and coding guidelines by aggressively linking to coding guidelines and documentation guidelines and scoping PR guidelines to the PR process.

timhoffm reviewed Dec 19, 2023
View reviewed changes
Comment thread doc/devel/coding_guide.rst
timhoffm reviewed Dec 19, 2023
View reviewed changes
Comment thread doc/devel/coding_guide.rst Outdated
story645 force-pushed the dev_shuffle branch 7 times, most recently from 0723cb5 to 81fdb40 Compare December 19, 2023 16:25
story645 force-pushed the dev_shuffle branch 3 times, most recently from f006688 to 283e299 Compare December 19, 2023 19:29
timhoffm reviewed Dec 19, 2023
View reviewed changes
Comment thread doc/devel/license.rst Outdated
Comment thread doc/devel/triage.rst Outdated
this reason, it is important to curate the issue list, adding labels
to issues and closing issues that are resolved or unresolvable.

Improving issues increases their chances of being successfully resolved.

timhoffm Dec 19, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I find "Improving issues" somewhat confusing, because it can have one of the two meanings:

  • work towards solving the issue (= improving an issue of the library)
  • work towards improving the issue description.

Would "Improving issue reports" be ok?

Take or leave as this has been there before. We want to take quick improvements along the way, but don't want to get lost in details.

story645 Dec 20, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

reworking this language to try and make it clearer its about writing the issue.

Comment thread doc/devel/triage.rst Outdated
Comment thread doc/devel/coding_guide.rst Outdated
Comment thread doc/devel/contribute.rst Outdated
reorganizing contributing docs to clean up toc
3289773 
create seperation between guidelines
make contributing guide more newbie oriented
streamline triage guide
moved api guide out of coding guidelines

Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
timhoffm approved these changes Dec 20, 2023
View reviewed changes

timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM.

timhoffm merged commit 091e2ca into matplotlib:main Dec 20, 2023

lumberbot-app Bot commented Dec 20, 2023

Copy link
Copy Markdown

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.8.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 091e2ca2e7ab0f48b826c2b8c7fbdc920803ad9c
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #27265: DOC: reorganizing contributing docs to clean up toc, better seperate topics'
  1. Push to a named branch:
git push YOURFORK v3.8.x:auto-backport-of-pr-27265-on-v3.8.x
  1. Create a PR against branch v3.8.x, I would have named this PR:

"Backport PR #27265 on branch v3.8.x (DOC: reorganizing contributing docs to clean up toc, better seperate topics)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

lumberbot-app Bot commented Dec 20, 2023

Copy link
Copy Markdown

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.8.2-doc
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 091e2ca2e7ab0f48b826c2b8c7fbdc920803ad9c
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #27265: DOC: reorganizing contributing docs to clean up toc, better seperate topics'
  1. Push to a named branch:
git push YOURFORK v3.8.2-doc:auto-backport-of-pr-27265-on-v3.8.2-doc
  1. Create a PR against branch v3.8.2-doc, I would have named this PR:

"Backport PR #27265 on branch v3.8.2-doc (DOC: reorganizing contributing docs to clean up toc, better seperate topics)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

timhoffm modified the milestones: v3.8-doc, v3.9.0 Dec 20, 2023

timhoffm commented Dec 20, 2023

Copy link
Copy Markdown
Member

Removed the backport as doing this manually is not worth is IMHO.

story645 deleted the dev_shuffle branch December 20, 2023 14:38

story645 commented Dec 20, 2023

Copy link
Copy Markdown
Member Author

Bonus of matplotlib/matplotlib.org#36 is that there's often no need to backport dev docs anymore 😁

QuLogic changed the title DOC: reorganizing contributing docs to clean up toc, better seperate topics DOC: reorganizing contributing docs to clean up toc, better separate topics Apr 5, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

timhoffm timhoffm approved these changes
+1 more reviewer
melissawm melissawm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Documentation: devdocs files in doc/devel

Projects

None yet

Milestone

v3.9.0

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL