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.

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

Change directory of contributor guide to better match its name (with redirects) #1605

Merged
merged 12 commits into from
Jun 29, 2022

Conversation

namurphy
Copy link
Member

The directory name docs/development came from the name "Development Guide", which was later changed to "Contributor Guide". This PR renames the directory to docs/contributing to better match the new name.

I also used the sphinx-reredirect extension to set up redirects. This looks like a really helpful extension since we'll probably end up changing the names of pages again in the future too.

@github-actions github-actions bot added the docs PlasmaPy Docs at http://docs.plasmapy.org label Jun 29, 2022
@codecov
Copy link

codecov bot commented Jun 29, 2022

Codecov Report

Merging #1605 (069f083) into main (eb4b66b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1605   +/-   ##
=======================================
  Coverage   97.21%   97.21%           
=======================================
  Files          83       83           
  Lines        7961     7961           
=======================================
  Hits         7739     7739           
  Misses        222      222           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eb4b66b...069f083. Read the comment docs.

@namurphy namurphy added this to the 0.8.0 milestone Jun 29, 2022
Copy link
Member

@rocco8773 rocco8773 left a comment

Choose a reason for hiding this comment

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

Should we just delete docs/contributing/workflow.rst? If I remember correctly, it was only created as part of a demo for the 2021 hack week. I don't see why we should retain it. Especially since it's not referenced anywhere in the rest of the documentation.

@namurphy
Copy link
Member Author

Should we just delete docs/contributing/workflow.rst? If I remember correctly, it was only created as part of a demo for the 2021 hack week. I don't see why we should retain it. Especially since it's not referenced anywhere in the rest of the documentation.

Agreed. I keep meaning to work on this but too many other things keep coming up...sigh!

We did this as an example during Plasma Hack Week 2021, but never
got around to finishing it.  We can restore it later on.
@namurphy namurphy merged commit 3f502bc into PlasmaPy:main Jun 29, 2022
@namurphy namurphy deleted the rename-contrib-guide branch June 29, 2022 23:23
@namurphy namurphy mentioned this pull request Aug 18, 2022
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor guide docs PlasmaPy Docs at http://docs.plasmapy.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants