pingcap / website-docs

The next generation of PingCAP Docs. Powered by Gatsby ⚛️.
https://docs.pingcap.com/
MIT License
22 stars 34 forks source link

Add a version notice to TiDB Operator v1.0 docs #151

Closed ran-huang closed 3 years ago

ran-huang commented 3 years ago

TiDB Operator v1.0 docs are no longer actively maintained, and users are recommended to use TiDB Operator v1.1 (stable) directly. However, currently, because Google search results give more weight to v1.0 docs than v1.1, and we don't provide an obvious notice in v1.0 docs, some users are misguided to use v1.0.

So we propose adding a global version notice to v1.0 docs. For example:

Note:

You are viewing TiDB Operator v1.0 documentation, which is no longer actively maintained. For the latest stable version, click here.

ran-huang commented 3 years ago

/cc @YiniXu9506 @lilin90 @DanielZhangQD

ran-huang commented 3 years ago

Some references: https://docs.confluent.io/5.1.2/schema-registry/index.html image https://v1-17.docs.kubernetes.io/docs/concepts/ image https://docs.openstack.org/newton/index.html image

lilin90 commented 3 years ago

@ran-huang The notice text "You are viewing TiDB Operator v1.0 documentation, which is no longer actively maintained. For the latest stable version, click here." LGTM.

@yikeke What do you think of the notice text?

yikeke commented 3 years ago

LGTM

ran-huang commented 3 years ago

Chinese text: "您当前浏览的文档版本是 TiDB Operator v1.0,该版本已不再维护。点击此处查看最新稳定版本。"

@lilin90 @yikeke PTAL

yikeke commented 3 years ago

LGTM

YiniXu9506 commented 3 years ago

Deprecation note can be previewed here: image image

ran-huang commented 3 years ago

Deprecation note can be previewed here: image image

@YiniXu9506 LGTM, thanks!