Skip to content

Outdated detectable documentation translation #23316

Closed
@lunny

Description

@lunny

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    type/docsThis PR mainly updates/creates documentationtype/proposalThe new feature has not been accepted yet but needs to be discussed first.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions