Repository navigation
Promote how to install dependencies #1338
Description
Prior discussion:
I opened PR #1337 since I was puzzled that we tell people how to configure and build CPython before we tell them how to install third party dependencies for extension modules like tkinter, sqlite3, and curses; in my mind, we should tell people how to install dependencies before we tell them how to configure and build CPython. I asked about this on Discord, and based on the responses, I created PR #1337. However, reordering these sections is controversial, so we need more discussion.
Arguments for keeping the current layout:
- historically, most extension modules were considered optional; for most uses this is also the case, so a simple process (configure, build) is better than a complex process (install deps, configure, build)
Arguments for reordering the layout:
- from time to time, we topics are opened on Discord and bug-reports are opened on the CPython repo where people complain that their CPython build "failed" because dependencies for some extension modules were not found; often, the answer to these reports is to point them to Install dependencies in the Devguide
- many people do not view the extension modules of the stdlib as optional; they expect the stdlib to be "complete" when they build CPython locally
- more advanced developers/users may expect a layout where dependencies are installed before one configure and build CPython
Activity
erlend-aasland commentedon Jun 11, 2024
@ezio-melotti, please edit the OP if I misrepresented your arguments :)
erlend-aasland commentedon Jun 11, 2024
cc. @nedbat
erlend-aasland commentedon Jun 11, 2024
My initial proposal for how to promote the Install dependencies section was to simply reorder the Setup and building page so Install dependencies comes before Compile and build.
Other (and not necessarily conflicting) proposals are:
ezio-melotti commentedon Jun 12, 2024
I suggest we do the following:
setup-buildingpage (like the one in the "Lifecycle of a PR" page) which lists all the steps (including optional ones, marked as such) with links to the respective sections. This will give users a concise overview and provide a quick way to navigate the page and jump directly to the relevant section(s) (e.g. if they already havegitinstalled). This might also need to be within tabs for the different operating systems.I also wonder if the whole Compile and build section could use tabs for the different operating systems. This will make the whole page shorter and easier to navigate, and the tab switching can also be synced with the "quick guide", so that once the user picked their OS they won't see other instructions that are not relevant to them.
erlend-aasland commentedon Jun 13, 2024
I think all of your suggestions are worth doing, Ezio; thanks!