Repository navigation
DOCS: Remove How-to: Contributing - #17961
Conversation
| for it in the :ref:`users-guide-index`. And so on... I think you get the | ||
| idea. | ||
|
|
||
| Matplotlib is documented using the `sphinx |
There was a problem hiding this comment.
Is this mentioned anywhere else?
There was a problem hiding this comment.
hmm, I think most of this language would be great for a blog post, go back and forth about whether it should be shifted to the contributing docs section of contributing.
There was a problem hiding this comment.
@QuLogic With "this" do you mean sphinx? If so, that is mentioned in https://matplotlib.org/devdocs/devel/documenting_mpl.html
There was a problem hiding this comment.
@story645 Are you referring to the complete section? IMHO this is too chatty for the docs.
There was a problem hiding this comment.
Yes, I meant about Sphinx, mostly. It could be a tiny bit more explicit, but yea I see it is in that page.
story645
left a comment
story645
left a comment
There was a problem hiding this comment.
also jumping off what @efiring & @dopplershift said about keeping the FAQ around as a table of comments of sorts, should probably link out to the section that's being moved.
| We are continuously striving to improve our documentation. You as an end-user | ||
| of Matplotlib can a make valuable contribution to that because you will better | ||
| see the potentials for improvement compared to a core developer. These include | ||
| but are not limited to: |
There was a problem hiding this comment.
Tried to do this directly like 15 times and get a 404, so:
You as an end-user of Matplotlib can make a valuable contribution because you better (more clearly?) see the potentials for improvement as compared to a core developer.
| The documentation lives in the same GitHub repository as the code. | ||
| Contributions are proposed and accepted though the pull request mechanism. |
There was a problem hiding this comment.
The documentation source files live in the same Github repository as the code. Contributions are proposed and accepted through the pull request process
| for it in the :ref:`users-guide-index`. And so on... I think you get the | ||
| idea. | ||
|
|
||
| Matplotlib is documented using the `sphinx |
There was a problem hiding this comment.
hmm, I think most of this language would be great for a blog post, go back and forth about whether it should be shifted to the contributing docs section of contributing.
Contributing is handled in the developer guide. This PR removes the last "How-to: Contributing" section on documentation and updates the section "Contributing documentation" in the developer guide.
13ecc62 to
d89f063
Compare
I strongly favor limiting How-to to plotting related topics. You can rephrase every aspect as a how-to ("how to install Matplotlib", "how to find examples", "how to view the documentation", ...) but IMHO that does not do much good. It only bloats the How-To, making relevant information harder to find. These topics should be easily accessible from the main page and/or by search. It's not too bad already, but there's still room for improvement, which I will target later with another PR. |
jklymak
left a comment
jklymak
left a comment
There was a problem hiding this comment.
I agree that How-to is the whole manual, and this How-to should be how-to do something as an end product, not "how to do some process". OTOH we could consider changing the name of this page, or getting rid of it entirely. It seems disorganized...
|
I agree that this is disorganized - and probably wouldn't object removing it entirely. Though a How-To with carefully selected content would certainly be helpful. Here and in the two previous PRs, I've taken the slow route of just stripping "How-to: Contributing" and making sure all removed information is easily accessible in the contribution guide. More cleanup can always be done later. |
|
@story645 you are blocking this still... |
minor grammar edits
Sorry for committing directly, the new branch button 404s
|
Sorry, made some minor grammar changes directly, but will still approve if those are reverted |
|
Merging improvement. Of course follow-up PRs are welcome.... |
PR Summary
Contributing is handled in the developer guide.
This PR removes the last "How-to: Contributing" section on documentation
and updates the section "Contributing documentation" in the developer
guide.
Follow-up to #17837 and #17842. Partly addresses #17920.