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

Jump to bottom

Rename {Reference Guide -> Commands} and group the toctree for it #9718

Merged
merged 3 commits into from Apr 2, 2021
Merged

Rename {Reference Guide -> Commands} and group the toctree for it #9718

merged 3 commits into from Apr 2, 2021

Conversation

pradyunsg
Copy link
Member

@pradyunsg pradyunsg commented Mar 21, 2021 •
edited

Toward #9475
Builds upon #9717.

  • reST -> MyST
  • Roughly group the commands, based on what they work on.

@pradyunsg pradyunsg added type: docs Documentation related skip news Does not need a NEWS file entry (eg: trivial changes) labels Mar 21, 2021
@pradyunsg pradyunsg added this to In progress in Documentation improvements via automation Mar 21, 2021
@pradyunsg
Copy link
Member Author

My current plan for handling redirects here is to manually add a bunch of "Exact Redirect"s on https://readthedocs.org/dashboard/pip/redirects/, after we make the main release.

This will also need us to update how we're handling redirects, when we make the release, but that should be fairly straightforward. :)

@pradyunsg pradyunsg changed the title Rewrite Commands section's landing page Rename {Reference Guide -> Commands} and group the toctree for it Mar 21, 2021
@BrownTruck
Copy link
Contributor

Hello!

I am an automated bot and I have noticed that this pull request is not currently able to be merged. If you are able to either merge the master branch into this pull request or rebase this pull request against master then it will be eligible for code review and hopefully merging!

@BrownTruck BrownTruck added the needs rebase or merge PR has conflicts with current master label Mar 28, 2021
@pradyunsg pradyunsg force-pushed the docs/rename-reference-to-commands branch from eefd541 to 8547d46 Compare April 2, 2021 08:45
@pypa-bot pypa-bot removed the needs rebase or merge PR has conflicts with current master label Apr 2, 2021
@pradyunsg pradyunsg force-pushed the docs/rename-reference-to-commands branch from 8547d46 to 29cbd45 Compare April 2, 2021 08:50
@pradyunsg
Move /reference/ to /cli/
0147cd1
@pradyunsg
Rewrite Commands section's landing page
b2c5e10 
- reST -> MyST
- Roughly group the commands, based on what they work on.
@pradyunsg pradyunsg force-pushed the docs/rename-reference-to-commands branch from 29cbd45 to 43102e2 Compare April 2, 2021 10:33
@pradyunsg pradyunsg added skip news Does not need a NEWS file entry (eg: trivial changes) and removed skip news Does not need a NEWS file entry (eg: trivial changes) labels Apr 2, 2021
@pradyunsg
Copy link
Member Author

And... done! CI finished. This is so good. ^>^

@pradyunsg pradyunsg force-pushed the docs/rename-reference-to-commands branch from 43102e2 to 3fe1954 Compare April 2, 2021 10:38
@pradyunsg
Copy link
Member Author

Verified that all the redirects do work on ReadTheDocs. Let's do this! ^>^

@pradyunsg
Copy link
Member Author

Merging since... well, this is a big improvement IMO. :)

@pradyunsg pradyunsg merged commit 6630ec3 into pypa:main Apr 2, 2021
Documentation improvements automation moved this from In progress to Done Apr 2, 2021
@pradyunsg pradyunsg deleted the docs/rename-reference-to-commands branch April 2, 2021 10:40
@pradyunsg pradyunsg mentioned this pull request Apr 3, 2021
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
skip news Does not need a NEWS file entry (eg: trivial changes) type: docs Documentation related
Projects
Documentation improvements
  
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@pradyunsg @BrownTruck @pypa-bot