Rewrite the Getting Started and Installation Pages #10009
Conversation
pradyunsg
added
the
skip news
|
Oops! Need to setup GPG keys on the not-owned-by-me-but-in-my-possesion laptop! |
pradyunsg
force-pushed
the
new-getting-started-and-installation
branch
from
13ff11a
to
c5e9314
Compare
pradyunsg
force-pushed
the
new-getting-started-and-installation
branch
from
c5e9314
to
6af200a
Compare
pradyunsg
force-pushed
the
new-getting-started-and-installation
branch
from
6af200a
to
1b38636
Compare
|
Merging! If there's any concerns, just flag them in #9475 and I'll address them in a follow up. :) |
| More details about how {mod}`ensurepip` works and how it can be used, is | ||
| available in the standard library documentation. | ||
|
|
||
| ### `get-pip.py` |
There was a problem hiding this comment.
@pradyunsg looks like this title has lost its label causing https://github.com/pypa/packaging.python.org/pull/898/checks?check_run_id=2655734156#step:6:34 to fail.
There was a problem hiding this comment.
Hm... I think this refactoring removed a lot of labels: https://webknjaz.github.io/intersphinx-untangled/pip.pypa.io/
There was a problem hiding this comment.
I wonder if it's time to enable autolabel.
There was a problem hiding this comment.
@pradyunsg looks like this title has lost its label causing https://github.com/pypa/packaging.python.org/pull/898/checks?check_run_id=2655734156#step:6:34
Ah, nice catch.
We should probably update that to point to https://github.com/pypa/get-pip/#readme instead, since that's the source of truth for information about get-pip now.
I wonder if it's time to enable
autolabel.
I don't want every heading to be an "intersphinx contract" that this documentation needs to be mindful of when making changes.
Hm... I think this refactoring removed a lot of labels:
That's correct. Is that a problem somehow?
There was a problem hiding this comment.
That's correct. Is that a problem somehow?
My understanding is that they used to be exposed via intersphinx and now they are not. So this has probably broken some sphinx sites.
There was a problem hiding this comment.
I don't want every heading to be an "intersphinx contract" that this documentation needs to be mindful of when making changes.
I agree with this. I don't think that our previous documentation was well-enough structured that we want to be blocked from improving it just because some sites linked to individual sections. (I don't think that docs are ever so perfect that not being able to reorganise them is reasonable, actually...)
There was a problem hiding this comment.
I agree with this. I don't think that our previous documentation was well-enough structured that we want to be blocked from improving it just because some sites linked to individual sections. (I don't think that docs are ever so perfect that not being able to reorganise them is reasonable, actually...)
I believe that Pradyun's comment was not about the old titles but about enabling automatic label creation based on title names. Sphinx has a built-in extension called autolabel for this. With this, there wouldn't be any need to create manual labels before titles.
Toward #9475
Borrows from and closes #9137