Skip to content
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

DOC: links in hacking.rst go back to hacking.rst instead of their intended destinations. #18903

Closed
TiloRC opened this issue Jul 18, 2023 · 3 comments · Fixed by #18910
Closed

DOC: links in hacking.rst go back to hacking.rst instead of their intended destinations. #18903

TiloRC opened this issue Jul 18, 2023 · 3 comments · Fixed by #18910
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution
Milestone
1.12.0

Comments

@TiloRC
Copy link
Contributor

TiloRC commented Jul 18, 2023 •
edited

Issue with current documentation:

Edit: I think the links in the contributing guidelines should go to the SciPy website rather than .rst files.

I followed the link for new contributors which then took me to SciPy pull request guidelines. From SciPy pull request guidelines I clicked the link to the Ways to Contribute called hacking.rst. I tried to follow some of the links in this file, but all of them go back to hacking.rst which confused me. I kind of got the impression that maybe the links weren't supposed to work and they only work in a version of the file that might exist on the scipy website. If this is the case, then the popup for new contributors should have brought me to that page.

For example, :ref:numpy:howto-document should go to this page I believe: https://numpy.org/doc/1.19/docs/howto_document.html.

Idea or request for content:

It should be easy for new contributors to read about how to make contributions.

Additional context (e.g. screenshots, GIFs)

First I clicked "contributing guidelines"
Screen Shot 2023-07-17 at 9 49 30 PM

Then I clicked https://github.com/scipy/scipy/blob/main/doc/source/dev/hacking.rst.
Screen Shot 2023-07-17 at 9 50 04 PM

Finally I clicked: :ref:numpy:howto-document which took me to the same page I was on.
Screen Shot 2023-07-17 at 9 50 45 PM
@TiloRC TiloRC added the Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org label Jul 18, 2023
@TiloRC
Copy link
Contributor Author

TiloRC commented Jul 18, 2023

I found a link that seems to have suffered from link rot:

See John Hunter's BSD pitch

@tupui tupui added the good first issue Good topic for first contributor pull requests, with a relatively straightforward solution label Jul 18, 2023
@tupui
Copy link
Member

tupui commented Jul 18, 2023

Hi @TiloRC Thank you for reporting. Would you like to make a PR to change the link?

@TiloRC
Copy link
Contributor Author

TiloRC commented Jul 18, 2023

Would you like to make a PR to change the link?

Sure. Working on it.

TiloRC added a commit to TiloRC/scipy that referenced this issue Jul 18, 2023
@TiloRC
DOC: from CONTRIBUTING.rst link to SciPy website
9a28d05 
Links in CONTRIBUTING.rst went to other .rst files rather than
the SciPy website. New contributors who were routed to
CONTRIBUTING.rst from the new contributors pop up had a
hard time learning about how to contribute because the links
in hacking.rst don’t seem to work unless you read the file on
the SciPy website rather than GitHub.

This commit fixes the issue by linking to the SciPy website from
CONTRIBUTING.rst rather than other .rst files.

Also, the link to John Hunter's BSD pitch has suffered from link
rot, so I replaced the link to a new link to an archive of the
website.

Closes scipy#18903.
TiloRC added a commit to TiloRC/scipy that referenced this issue Jul 18, 2023
@TiloRC
DOC: from CONTRIBUTING.rst link to SciPy website
2fbb4ed 
Links in CONTRIBUTING.rst went to other .rst files rather than
the SciPy website. This is problematic because the links in the
other .rst files don’t work unless they are rendered.

Furthermore, new contributors are likely to see CONTRIBUTING.rst
because it is linked from the new contributors popup.

This commit fixes the issue by linking to the SciPy website from
CONTRIBUTING.rst rather than other .rst files.

Also, the link to John Hunter's BSD pitch has suffered from link
rot, so I replaced the link to a new link to an archive of the
website.

Closes scipy#18903.
@TiloRC TiloRC mentioned this issue Jul 18, 2023
Merged
@tupui tupui added this to the 1.12.0 milestone Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution
Projects
None yet
Milestone
1.12.0
Development

Successfully merging a pull request may close this issue.

DOC: from CONTRIBUTING.rst link to SciPy website TiloRC/scipy
2 participants
@tupui @TiloRC