Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Doc]: Improve contribute instructions #28005

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.

Sign up for GitHub

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

Jump to bottom
Closed
2 tasks done
timhoffm opened this issue Apr 2, 2024 · 19 comments
Closed
2 tasks done

[Doc]: Improve contribute instructions #28005

timhoffm opened this issue Apr 2, 2024 · 19 comments
Labels
Documentation: devdocs files in doc/devel Documentation
Milestone
v3.9.0

Comments

@timhoffm
Copy link
Member

timhoffm commented Apr 2, 2024 •
edited
Loading

Documentation Link

https://matplotlib.org/devdocs/devel/index.html

Problem / Suggested improvement
@story645
Copy link
Member

story645 commented Apr 2, 2024

Documentation Link

But maybe this should be left out here completely and instead be part of https://matplotlib.org/devdocs/devel/contribute.html#open-a-pull-request-on-matplotlib and/or https://matplotlib.org/devdocs/devel/development_workflow.html#open-a-pull-request

Generally I've been working on the assumption that contribute.rst is the guide for absolute beginners, and devolpment_workflow.rst is for more experienced folks, so hopefully written slightly differently for both.

@story645 story645 added the Documentation: devdocs files in doc/devel label Apr 2, 2024
@timhoffm
Copy link
Member Author

timhoffm commented Apr 2, 2024 •
edited
Loading

Generally I've been working on the assumption that contribute.rst is the guide for absolute beginners, and devolpment_workflow.rst is for more experienced folks, so hopefully written slightly differently for both.

I‘d rather phrase this as: contribute.rst is the first point of contact and a high-level overview directing people to the more detailed instuctions, and development_workflow.rst is one such instruction.

@story645
Copy link
Member

story645 commented Apr 2, 2024

a high-level overview directing people to the more detailed instuctions,

Yeah, I think both are ways of describing low->medium->high context, which is roughly the leveling scheme we use for issues & in the tags.

timhoffm added a commit to timhoffm/matplotlib that referenced this issue Apr 2, 2024
@timhoffm
DOC: Move bug reports and feature requests to top of contributing index
3ba1e42 
Partially adresses matplotlib#28005.

The two sections "Report a bug" and "Request a feature" were burried
inside of contribute.rst. They were a bit foreign there because all
other content is on direct involvement with the project, which needs
much more information.

To keep things focussed and directly redirect the "simple" bug report
and feature request topics to GitHub, I've deleted the sections and
instead created two cards at the top of devel/index.rst with
essentially the content of the sections. Note that I've the list of
things to include in bug reports because that's covered by our issue
template on GitHub nowadays and does not need repetition here.
@timhoffm timhoffm mentioned this issue Apr 2, 2024
Merged
timhoffm added a commit to timhoffm/matplotlib that referenced this issue Apr 2, 2024
@timhoffm
DOC: Move bug reports and feature requests to top of contributing index
1a0f4d2 
Partially adresses matplotlib#28005.

The two sections "Report a bug" and "Request a feature" were burried
inside of contribute.rst. They were a bit foreign there because all
other content is on direct involvement with the project, which needs
much more information.

To keep things focussed and directly redirect the "simple" bug report
and feature request topics to GitHub, I've deleted the sections and
instead created two cards at the top of devel/index.rst with
essentially the content of the sections. Note that I've the list of
things to include in bug reports because that's covered by our issue
template on GitHub nowadays and does not need repetition here.
timhoffm added a commit to timhoffm/matplotlib that referenced this issue Apr 3, 2024
@timhoffm @story645
DOC: Move bug reports and feature requests to top of contributing index
6d59be5 
Partially adresses matplotlib#28005.

The two sections "Report a bug" and "Request a feature" were burried
inside of contribute.rst. They were a bit foreign there because all
other content is on direct involvement with the project, which needs
much more information.

To keep things focussed and directly redirect the "simple" bug report
and feature request topics to GitHub, I've deleted the sections and
instead created two cards at the top of devel/index.rst with
essentially the content of the sections. Note that I've the list of
things to include in bug reports because that's covered by our issue
template on GitHub nowadays and does not need repetition here.

Co-authored-by: hannah <[email protected]>
timhoffm added a commit to timhoffm/matplotlib that referenced this issue Apr 4, 2024
@timhoffm @story645
DOC: Move bug reports and feature requests to top of contributing index
13abf45 
Partially adresses matplotlib#28005.

The two sections "Report a bug" and "Request a feature" were burried
inside of contribute.rst. They were a bit foreign there because all
other content is on direct involvement with the project, which needs
much more information.

To keep things focussed and directly redirect the "simple" bug report
and feature request topics to GitHub, I've deleted the sections and
instead created two cards at the top of devel/index.rst with
essentially the content of the sections. Note that I've the list of
things to include in bug reports because that's covered by our issue
template on GitHub nowadays and does not need repetition here.

Co-authored-by: hannah <[email protected]>
@Impaler343
Copy link
Contributor

I dont know if this is being fixed in this Issue, but all of the links in this pic lead to the top of the Contribute page, while they should be leading to different sections of the page. But the URLs they lead to are all different
image

timhoffm added a commit to timhoffm/matplotlib that referenced this issue Apr 4, 2024
@timhoffm @story645
DOC: Move bug reports and feature requests to top of contributing index
36965ac 
Partially adresses matplotlib#28005.

The two sections "Report a bug" and "Request a feature" were burried
inside of contribute.rst. They were a bit foreign there because all
other content is on direct involvement with the project, which needs
much more information.

To keep things focussed and directly redirect the "simple" bug report
and feature request topics to GitHub, I've deleted the sections and
instead created two cards at the top of devel/index.rst with
essentially the content of the sections. Note that I've the list of
things to include in bug reports because that's covered by our issue
template on GitHub nowadays and does not need repetition here.

Co-authored-by: hannah <[email protected]>
@timhoffm timhoffm mentioned this issue Apr 4, 2024
Merged
@story645
Copy link
Member

story645 commented Apr 5, 2024

I dont know if this is being fixed in this Issue, but all of the links in this pic lead to the top of the Contribute page, while they should be leading to different sections of the page. But the URLs they lead to are all different

I can't replicate this, so which browser are you on and which version of the docs?

@story645 story645 mentioned this issue Apr 5, 2024
Merged
5 tasks
@Impaler343
Copy link
Contributor

I dont know if this is being fixed in this Issue, but all of the links in this pic lead to the top of the Contribute page, while they should be leading to different sections of the page. But the URLs they lead to are all different

I can't replicate this, so which browser are you on and which version of the docs?

Doc version - 3.8.4, 3.8.3
Browser - Google Chrome, Firefox, Edge
On mobile as well. I search for "matplotlib documentation" --> click on the first link --> Click on Contribute under the Contribute section --> Click on one of the links

@story645
Copy link
Member

story645 commented Apr 5, 2024

Ugh still can't replicate :/ have you cleared/ can you clear your cache?

@timhoffm
Copy link
Member Author

timhoffm commented Apr 5, 2024

-> click on the first link -->

Please post this link.

@rcomer
Copy link
Member

rcomer commented Apr 5, 2024 •
edited
Loading

In iOS Safari, if I "open in background" (equivalent to open in new tab in most browsers) the link always takes me to the top of the page. Are you doing something like that @Impaler343?

@timhoffm
Copy link
Member Author

timhoffm commented Apr 5, 2024

@rcomer What is the link target? If it is correct, IMHO then the browser is acting funny and we cannot do anything about it.

@rcomer
Copy link
Member

rcomer commented Apr 5, 2024 •
edited
Loading

Yes, I always assumed this was a browser issue. If I just tap the link, I get to the right place.

@timhoffm timhoffm added this to the v3.9.0 milestone Apr 6, 2024
@timhoffm
Copy link
Member Author

timhoffm commented Apr 6, 2024

Fixed by PRs #28011, #28024, #28026.

The link discussion is OT and a browser issue that we cannot do anything about.

@timhoffm timhoffm closed this as completed Apr 6, 2024
@Impaler343
Copy link
Contributor

Impaler343 commented Apr 6, 2024 •
edited
Loading

-> click on the first link -->

Please post this link.

https://matplotlib.org/stable/index.html

@Impaler343
Copy link
Contributor

Impaler343 commented Apr 6, 2024 •
edited
Loading

Fixed by PRs #28011, #28024, #28026.

The link discussion is OT and a browser issue that we cannot do anything about.

Hmmmmm I wonder why all of my browsers are acting funny. I even tried on a couple of my friends' browsers

@Impaler343
Copy link
Contributor

In iOS Safari, if I "open in background" (equivalent to open in new tab in most browsers) the link always takes me to the top of the page. Are you doing something like that @Impaler343?

I don't have Safari but when I try to open in a new tab, I the problem still persists

@Impaler343
Copy link
Contributor

Ugh still can't replicate :/ have you cleared/ can you clear your cache?

Just tried this, didn't work 🥲

@story645
Copy link
Member

story645 commented Apr 7, 2024

Fixed by PRs #28011, #28024, #28026.

The link discussion is OT and a browser issue that we cannot do anything about.

Hmmmmm I wonder why all of my browsers are acting funny. I even tried on a couple of my friends' browsers

Can you take a screen cast to show us?

@Impaler343
Copy link
Contributor

Fixed by PRs #28011, #28024, #28026.
The link discussion is OT and a browser issue that we cannot do anything about.

Hmmmmm I wonder why all of my browsers are acting funny. I even tried on a couple of my friends' browsers

Can you take a screen cast to show us?

Matplotlib.mp4

@Impaler343
Copy link
Contributor

Impaler343 commented Apr 7, 2024 •
edited
Loading

In iOS Safari, if I "open in background" (equivalent to open in new tab in most browsers) the link always takes me to the top of the page. Are you doing something like that @Impaler343?

Just checked and works well on safari, must be a browser issue on all the other ones.
The new tab method works with firefox, edge and chrome on desktop and not on mobile

@timhoffm timhoffm mentioned this issue Apr 15, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation: devdocs files in doc/devel Documentation
Projects
None yet
Milestone
v3.9.0
Development

No branches or pull requests
4 participants
@story645 @timhoffm @rcomer @Impaler343