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

Documentation Content: TOC — Learning Section Descriptions #12523

Conversation

nate-double-u
Copy link
Contributor

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

This PR builds on #12509 & #12512

Adding descriptions to Documentation/learning files' frontmatter so that we can use them as annotations for the TOC

Screenshots of changes

Section page Sample page
Screenshot_2020-12-04 Learning Screenshot_2020-12-04 Glossary

Related to issue etcd-io/website#81

This is a first pass on writing descriptions for this section, feedback is welcome!

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
Contributor Author

@spzala

@nate-double-u
Copy link
Contributor Author

Note, this was branched off the #12512 PR. If the weights change there from feedback, I'll update this PR.

Copy link
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.

@nate-double-u lgtm, but have couple of small comments. Thanks!

Documentation/learning/design-auth-v3.md Outdated Show resolved Hide resolved
Documentation/learning/design-learner.md Outdated Show resolved Hide resolved
@nate-double-u nate-double-u force-pushed the 81-docs-toc-learning-descriptions branch from 8654ef8 to a0a7786 Compare December 9, 2020 02:37
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 nate-double-u force-pushed the 81-docs-toc-learning-descriptions branch from a0a7786 to 3eb4c9d Compare December 9, 2020 02:41
@nate-double-u
Copy link
Contributor Author

Updated as per #12509 (comment), and updated for PR copy feedback.

@nate-double-u
Copy link
Contributor Author

Closing in favor of #12575, which merges all the "Documentation Content: TOC" PRs into one commit.

@nate-double-u nate-double-u deleted the 81-docs-toc-learning-descriptions branch December 23, 2020 20:09
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.

None yet

2 participants