Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Add 'Show translation source' to docs sidebar #130355

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
Loading
from

Conversation

StanFromIreland
Copy link
Contributor

@StanFromIreland StanFromIreland commented Feb 20, 2025

Doc/tools/templates/customsourcelink.html Outdated Show resolved Hide resolved
@hugovk hugovk added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Feb 20, 2025
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Doc/tools/templates/customsourcelink.html Show resolved Hide resolved
@m-aciek
Copy link
Contributor

m-aciek commented Feb 20, 2025

I suggest to change the PR title to make it clear it's about the docs.

@StanFromIreland StanFromIreland changed the title Add 'Show translation source' to sidebar Add 'Show translation source' to docs sidebar Feb 20, 2025
@AA-Turner
Copy link
Member

I'm -1 on this. .po files are not very friendly for reading by people, and are designed as a translation format mapping source to translated strings. I similarly see little value in 'show source', as the reStructuredText source is so unlikely to be useful (some themes have replaced this with a link to the source on GitHub, but I'm still unconvinced).

A

@hugovk
Copy link
Member

hugovk commented Feb 20, 2025

I often use "show source" when I want to check, well, the source, for example if there's something amiss.

If there's a translation that's missing or fixing, is the .po file the file that needs editing? If so, this would make it easy to click through and make a quick PR.

@StanFromIreland
Copy link
Contributor Author

Hugo already mentioned the main point.

Another thing is the current „show source” button is useless in the translations as it is the English source.

This will contributions as it is easy to find where the files are as the repo is not linked anywhere else in the docs!

And also, Adam, you don’t have to worry about seeing it :-)

Doc/tools/templates/customsourcelink.html Show resolved Hide resolved
@m-aciek
Copy link
Contributor

m-aciek commented Mar 4, 2025

I personally use "Show source" very rarely. But I think "Show translation source" would be as useful as "Show source" is, for translated content.

@tomasr8 tomasr8 removed the needs backport to 3.12 only security fixes label Apr 10, 2025
@StanFromIreland
Copy link
Contributor Author

Is there anything else left to do here @hugovk ?

@StanFromIreland
Copy link
Contributor Author

Friendly ping, so that we can get this in.

@hugovk
Copy link
Member

hugovk commented May 5, 2025

Adam is -1, let me check in with him. We're not in a rush to get this in before the beta feature freeze, it can also go in after and be backported.

@m-aciek
Copy link
Contributor

m-aciek commented May 6, 2025

If there's a translation that's missing or fixing, is the .po file the file that needs editing? If so, this would make it easy to click through and make a quick PR.

That question wasn’t answered directly (assuming it wasn’t just rhetorical). Yes, the .po file should be edited in case of a missing or incorrect translation. That’s a good point—using PR-based translation workflows, this should be a convenient change.

@m-aciek
Copy link
Contributor

m-aciek commented May 7, 2025

We could use Plausible custom events to track the usage of the show source link. Though it looks like it would require changes in both theme and the show source customization in the CPython's repo.

@serhiy-storchaka serhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.