cockroachdb / cockroachdb/docs
All links and TOC entries should use exact page titles
- 主要言語
- HTML
- スター
- 212
- フォーク
- 476
- 平均マージ
- 40分
- マージ済み PR(30日)
- 3
説明
Richard Loveland (rmloveland) commented:
Currently, there are instances of TOC entries that don't match the page title they're referring to, and link text that does not match the title of the target page.
This is inconsistent and may lead to confusion. For example, I might be wonder if I am looking at the right page, or if the link is pointing to something I'm interested in.
Here are some concrete examples of mismatches (seen at random, no desire to pick on specific people, I am also "guilty"):
- TOC entries that say 'Tuning Tutorial', but the page title says 'Performance Tuning' (https://www.cockroachlabs.com/docs/v19.2/performance-tuning-insecure.html)
- Link text that says 'SQL Best Practices', but the page is actually entitled 'SQL Performance Best Practices' (https://www.cockroachlabs.com/docs/v19.2/sql-tuning-with-explain.html)
Estimated scope of work:
- Audit all TOC items and ensure that TOC title and YAML title and title displayed on page are the same
- Audit links and ensure that link titles match the titles of the pages they point to (except in obvious cases such as when the link is embedded in prose a la "See [here]() for a thing").
Jira Issue: DOC-367
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
評価
この issue はまだ評価されていません。