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

Doc-version landing pages need rework #300

Closed
8 tasks
chalin opened this issue May 21, 2021 · 0 comments · Fixed by #353
Closed
8 tasks

Doc-version landing pages need rework #300

chalin opened this issue May 21, 2021 · 0 comments · Fixed by #353
Assignees
Labels
e0-minutes Effort: < 60 min e1-hours Effort: < 8 hrs in progress Indicates that an Issue is actively being worked on.

Comments

@chalin
Copy link
Contributor

chalin commented May 21, 2021

On desktop, readers have direct access to the following links on every documentation page:

Most doc-version landing pages have a sentence of the form "Improvements to these docs are encouraged through pull requests to the etcd project on GitHub", with a link to the etcd repo -- from the days where the docs were in that repo. Given the GH issue links on each page, let's drop that sentence from the opening paragraph of each doc-version landing page.

  • v2.4: drop "Improvements to these docs are encouraged through pull requests to the etcd project on GitHub".
  • v3.1: drop "Improvements to these docs are ... project on GitHub".
  • v3.2: drop "Improvements to these docs are ... project on GitHub".
  • v3.3: add a paragraph so that it matches the (edited) v3.4 page's opening text.
  • v3.4: drop "Improvements to these docs are ... project on GitHub".
  • v3.5:
    • Drop "Improvements to these docs are ... project on GitHub"
    • Simplify the first sentence to match v3.4. (The word DRAFT is prevalent enough on the page, we don't need another mention of, say, "upcoming" in the opening sentence.) This will also make it easier when creating the v3.5 directory.
chalin added a commit that referenced this issue May 21, 2021
@chalin chalin mentioned this issue May 21, 2021
21 tasks
@chalin chalin changed the title Doc version landing pages need rework Doc-version landing pages need rework May 21, 2021
@chalin chalin added e0-minutes Effort: < 60 min e1-hours Effort: < 8 hrs labels Jun 2, 2021
@nate-double-u nate-double-u added the in progress Indicates that an Issue is actively being worked on. label Jun 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e0-minutes Effort: < 60 min e1-hours Effort: < 8 hrs in progress Indicates that an Issue is actively being worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants