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

Outdated detectable documentation translation #23316

Closed
lunny opened this issue Mar 5, 2023 · 4 comments
Closed

Outdated detectable documentation translation #23316

lunny opened this issue Mar 5, 2023 · 4 comments
Labels
type/docs This PR mainly updates/creates documentation type/proposal The new feature has not been accepted yet but needs to be discussed first.

Comments

@lunny
Copy link
Member

lunny commented Mar 5, 2023

Feature Description

Currently, when you view a non-English documentation, you don't know if it's outdated or not.

I propose adding new metadata key version to every documentation page like

---
date: "2016-12-01T16:00:00+02:00"
version: 1
---

And everytime a documentation update, we need to check whether we need to upgrade the version within the PR.
If it's an English documentation and extra content added, the version should be incremented 1.
If it's a non-English documentation and the change will make it keep consistent with related English version, then change the version to the same value which is in the English version documentation.

So, when we generated non-English version documentation, if version is not the same as related English version, it's outdated. Then we can add a top warning bar to display that this documentation is outdated.

Screenshots

No response

@lunny lunny added type/proposal The new feature has not been accepted yet but needs to be discussed first. type/docs This PR mainly updates/creates documentation labels Mar 5, 2023
@delvh
Copy link
Member

delvh commented Mar 5, 2023

Or we simply start adding our docs files to Crowdin/ Weblate/ …, and can simply use the latest version without a version requirement.

@lunny
Copy link
Member Author

lunny commented Mar 5, 2023

Or we simply start adding our docs files to Crowdin/ Weblate/ …, and can simply use the latest version without a version requirement.

I don't whether it's suitable to translate the article in crowdin?

@a1012112796
Copy link
Member

a1012112796 commented Apr 8, 2024

Or we simply start adding our docs files to Crowdin/ Weblate/ …, and can simply use the latest version without a version requirement.

I don't whether it's suitable to translate the article in crowdin?

looks the wails project has using crowdin for the documents translation, ref: https://crowdin.com/project/wails/zh-CN

https://docusaurus.io/zh-CN/docs/i18n/crowdin

@lunny
Copy link
Member Author

lunny commented Jun 13, 2024

@lunny lunny closed this as completed Jun 13, 2024
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Sep 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type/docs This PR mainly updates/creates documentation type/proposal The new feature has not been accepted yet but needs to be discussed first.
Projects
None yet
Development

No branches or pull requests

3 participants