Skip to content

Documentation Content: TOC — Sections Order#12509

Merged
spzala merged 1 commit intoetcd-io:masterfrom
nate-double-u:81-docs-toc-sections
Dec 19, 2020
Merged

Documentation Content: TOC — Sections Order#12509
spzala merged 1 commit intoetcd-io:masterfrom
nate-double-u:81-docs-toc-sections

Conversation

@nate-double-u
Copy link
Copy Markdown
Contributor

@nate-double-u nate-double-u commented Dec 3, 2020

Updating the primary sections order by adding weights to main section .md files.

Related to issue etcd-io/website#81

Original order Updated Order
Screen Shot 2020-12-03 at 2 17 57 PM Screenshot_2020-12-09 etcd version ___
Documentation sections
* Benchmarks
* Developer guide
* Learning
* Operations guide
* Platforms
* Triage
* Upgrading
Documentation sections
* Learning
* Developer guide
* Operations guide
* Benchmarks
* Upgrading
* Platforms
* Triage

This is a first pass on the order. Feedback is welcome!

@nate-double-u
Copy link
Copy Markdown
Contributor Author

@spzala

@nate-double-u
Copy link
Copy Markdown
Contributor Author

Note, CI failure is not related to doc change.

Copy link
Copy Markdown
Member

@spzala spzala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nate-double-u lgtm but nits,

  1. I guess all the files here still needsdescriptions?
  2. Can we keep please order as below:
  • Learning
  • Developer guide
  • Operations guide
  • Benchmarks
  • Upgrading
  • Platforms
  • Triage
    You can hold on to making changes for a day or two if anyone else has comments but otherwise I would make the order as above. (also, I think Triage doesn't belong here but let's not complicate things here, we can do that in separately in future) Thanks!

@nate-double-u
Copy link
Copy Markdown
Contributor Author

Thanks for the feedback! I'm doing descriptions separately in other PRs as I think they'll probably need a closer look.

@spzala
Copy link
Copy Markdown
Member

spzala commented Dec 5, 2020

Thanks for the feedback! I'm doing descriptions separately in other PRs as I think they'll probably need a closer look.

OK, that's fine. Thanks!

Updating for new TOC as per issue etcd-io/website#81

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
@nate-double-u
Copy link
Copy Markdown
Contributor Author

nate-double-u commented Dec 9, 2020

2. Can we keep please order as below:
* Learning
* Developer guide
* Operations guide
* Benchmarks
* Upgrading
* Platforms
* Triage

Updated.

@nate-double-u
Copy link
Copy Markdown
Contributor Author

nate-double-u commented Dec 9, 2020

With these changes I think this PR is ready for merge now.
@spzala

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants