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

Update titles and subtitles on landing page template #116914

Merged
merged 4 commits into from
Mar 17, 2024

Conversation

willingc
Copy link
Contributor

@willingc willingc commented Mar 16, 2024

This PR updates the titles and subtitles on the docs landing page:

  • Subtitles are edited for clarity and to match our current documentation goals
    • Clarify Tutorial subtitle
    • Clarify HOWTO subtitle since this section is a mix of reference, how-to, and explanation docs
  • Titles and subtitles are given consistent case.

📚 Documentation preview 📚: https://cpython-previews--116914.org.readthedocs.build/

@willingc willingc added docs Documentation in the Doc dir skip issue skip news labels Mar 16, 2024
@willingc willingc requested review from a team and hugovk March 16, 2024 19:55
Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

Thanks for digging in here!

Doc/tools/templates/indexcontent.html Outdated Show resolved Hide resolved
Doc/tools/templates/indexcontent.html Outdated Show resolved Hide resolved
Doc/tools/templates/indexcontent.html Outdated Show resolved Hide resolved
Doc/tools/templates/indexcontent.html Outdated Show resolved Hide resolved
Doc/tools/templates/indexcontent.html Outdated Show resolved Hide resolved
Doc/tools/templates/indexcontent.html Outdated Show resolved Hide resolved
Doc/tools/templates/indexcontent.html Outdated Show resolved Hide resolved
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

Doc/tools/templates/indexcontent.html Outdated Show resolved Hide resolved
@willingc willingc enabled auto-merge (squash) March 16, 2024 23:56
@willingc willingc merged commit c514a97 into python:main Mar 17, 2024
25 checks passed
@hugovk
Copy link
Member

hugovk commented Mar 18, 2024

Should we backport this to 3.12 = https://docs.python.org/3/ and 3.11 = https://docs.python.org/3.11/?

@gvanrossum
Copy link
Member

SGTM.

@willingc willingc added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Mar 19, 2024
@miss-islington-app
Copy link

Thanks @willingc for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Thanks @willingc for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 19, 2024
* Update titles and subtitles on landing page template

* address review from gvanrossum

* Edits from hugovk review

* Change word order back. Down the road we should split license and history
(cherry picked from commit c514a97)

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
@bedevere-app
Copy link

bedevere-app bot commented Mar 19, 2024

GH-117019 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 Mar 19, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 19, 2024
* Update titles and subtitles on landing page template

* address review from gvanrossum

* Edits from hugovk review

* Change word order back. Down the road we should split license and history
(cherry picked from commit c514a97)

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
@bedevere-app
Copy link

bedevere-app bot commented Mar 19, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Mar 19, 2024
willingc added a commit that referenced this pull request Mar 19, 2024
… (#117019)

Update titles and subtitles on landing page template (GH-116914)

* Update titles and subtitles on landing page template

* address review from gvanrossum

* Edits from hugovk review

* Change word order back. Down the road we should split license and history
(cherry picked from commit c514a97)

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
willingc added a commit that referenced this pull request Mar 19, 2024
… (#117020)

Update titles and subtitles on landing page template (GH-116914)

* Update titles and subtitles on landing page template

* address review from gvanrossum

* Edits from hugovk review

* Change word order back. Down the road we should split license and history
(cherry picked from commit c514a97)

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
vstinner pushed a commit to vstinner/cpython that referenced this pull request Mar 20, 2024
* Update titles and subtitles on landing page template

* address review from gvanrossum

* Edits from hugovk review

* Change word order back. Down the road we should split license and history
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 25, 2024
* Update titles and subtitles on landing page template

* address review from gvanrossum

* Edits from hugovk review

* Change word order back. Down the road we should split license and history
diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
* Update titles and subtitles on landing page template

* address review from gvanrossum

* Edits from hugovk review

* Change word order back. Down the road we should split license and history
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 issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants