Skip to content

Organize index of guides into 3 categories - #708

Merged
di merged 3 commits into
pypa:masterfrom
pastelmind:organize-guides-index
Dec 11, 2020
Merged

Organize index of guides into 3 categories#708
di merged 3 commits into
pypa:masterfrom
pastelmind:organize-guides-index

Conversation

@pastelmind

Copy link
Copy Markdown
Contributor

Split the toctree of guides into three broad categories:

  • Installing Packages
    • Includes guides for installing and managing dependencies.
  • Building and Publishing Projects
    • Includes guides for project configuration, distribution
  • Miscellaneous
    • Guides that do not clearly fit into any of the above

This commit primarily affects the Guides index page; it does not create nested lists for each category in the sidebar.

Split the toctree of guides into three broad categories:

- Installing Packages
    - Includes guides for installing and managing dependencies.
- Building and Publishing Projects
    - Includes guides for project configuration, distribution
- Miscellaneous
    - Guides that do not clearly fit into any of the above

This commit primarily affects the Guides index page; it does not create
nested lists for each category in the sidebar.
@webknjaz
webknjaz requested a review from a team December 10, 2020 15:39
Comment thread source/guides/index.rst Outdated
Comment on lines +42 to +43
index-mirrors-and-caches
hosting-your-own-index

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think these two should be under "installing".

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good point. If I update the PR, do I have to wait another 9 months to get another review?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

No.

@pastelmind

Copy link
Copy Markdown
Contributor Author

@di Moved the two items. I'm sorry about making a snarky comment earlier.

@pradyunsg

Copy link
Copy Markdown
Member

Comparing the sidebar between https://packaging.python.org/ and https://python-packaging-user-guide--708.org.readthedocs.build/, I'd prefer to keep the sidebar unchanged.

Is there some change that I'm missing?

@di

di commented Dec 11, 2020

Copy link
Copy Markdown
Member

@pradyunsg Looks like that was due to the branch being out of date.

@di
di merged commit 9ef40af into pypa:master Dec 11, 2020
@di

di commented Dec 11, 2020

Copy link
Copy Markdown
Member

Thanks @pastelmind!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants