Skip to content

GH-104395: Add a link in 'Meta Information' to the docs download page #104443

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

Merged
merged 2 commits into from
Sep 12, 2023

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented May 13, 2023

@terryjreedy
Copy link
Member

I have no opinion at the moment.

Copy link
Member

@ned-deily ned-deily left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@adorilson
Copy link
Contributor

adorilson commented May 15, 2023

books Documentation preview books: https://cpython-previews--104443.org.readthedocs.build/

Thanks for your PR, @AA-Turner .

I just would like to do a suggestion more.

Download sounds more related to "Reporting bugs" and "Contributing to Docs" items than "History" and "Copyright" ones. By other hand, "About" seems more related to this latest.

So, I suggest:

First column:

  • Reporting...
  • Contributing...
  • Download...

Second column:

  • About...
  • History...
  • Copyright

Maybe this can be a little detail, but it do more sense for me as a user.

@hugovk
Copy link
Member

hugovk commented May 15, 2023

So instead of:

image

Flip the last two:

image

Seems okay to me: first column are things to do, second is just information.

@CAM-Gerlach
Copy link
Member

FWIW, the other items have rather strange, distracting and inconstant case (sentence/title), phrasing (Docs/documentation, "of Python" or not) and ordering (should most logically be About, History, Copyright), but if we're adding this one, may as well at least add it where it makes the most sense.

@adorilson
Copy link
Contributor

@CAM-Gerlach I agree with you.

But one point more. Maybe "History and License" is in wrong section, because the others items are about documentation (meta information), but it is about Python itself. So, what if move this item to "Parts of documentation" section?

@JulienPalard
Copy link
Member

Feel strange that on the top left we have "Download these documents" and at the bottom "Download the documentation", should the wording be unified?

I'm also not a fan to duplicate this link, should it really be duplicated, or just moved out of the sidebar?

While we're at it: should the sidebar be kept at all? The version picker already exists on the top of the page, and maybe other things can be moved.

It would provide more space for the main page, allowing to make it more user friendly. I remember when I started Python I "feared" this page: too many links, eyes were lost looking at it.

@hugovk hugovk added the needs backport to 3.12 only security fixes label Sep 12, 2023
@hugovk
Copy link
Member

hugovk commented Sep 12, 2023

Jist today, someone said they wished they could download the Python tutorial as PDF or epub, not realising they're already available.

Let's merge this, it's an improvement over the current situation. And we can open a new issue or PR if we wish to make further changes.

@hugovk hugovk enabled auto-merge (squash) September 12, 2023 20:24
@hugovk hugovk merged commit 90cf345 into python:main Sep 12, 2023
@miss-islington
Copy link
Contributor

Thanks @AA-Turner for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 12, 2023
…d page (pythonGH-104443)

(cherry picked from commit 90cf345)

Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Sep 12, 2023

GH-109345 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Sep 12, 2023
@bedevere-app
Copy link

bedevere-app bot commented Sep 12, 2023

GH-109346 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Sep 12, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 12, 2023
…d page (pythonGH-104443)

(cherry picked from commit 90cf345)

Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
hugovk added a commit that referenced this pull request Sep 12, 2023
…ad page (GH-104443) (#109346)

Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Yhg1s pushed a commit that referenced this pull request Sep 13, 2023
…ad page (GH-104443) (#109345)

GH-104395: Add a link in 'Meta Information' to the docs download page (GH-104443)
(cherry picked from commit 90cf345)

Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
vstinner pushed a commit to vstinner/cpython that referenced this pull request Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants