-
Notifications
You must be signed in to change notification settings - Fork 308
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
Update quickstart and new user workflows #782
Comments
Usage varies, but the Etc docs have used Quickstart (one word) from the start (or at least for a while now), as do other sites like GH, see: |
If we break down the opening comment guidance, I see these tasks:
And:
I'm assuming that the separate "Getting started" workflows refer to separate pages, not to be crammed into the single Quickstart page, right @dwelsch-esi? /cc @nate-double-u |
Ah, I'm recalling why there wasn't a separate "Prerequisites" section. If you look at the current Quickstart, it is sooo simple, that it didn't make sense at the time to separate out the Prerequisites from the steps. Also, @dwelsch-esi, have you outlined somewhere how you see the separate "Getting started" workflows taking shape? |
Just my two cents, if they were to be separate pages, then the "Quickstart" should still refer to those pages, no? |
Overview
Rename to "Quick start" (two words). Add a "Prerequisites" section and revise the "What's next" section to focus on two separate paths, Development and Operations. Write separate "Getting started" workflows for Developer and Operator users. For the developer path, link to the "Set up a local cluster" page rather than the install page.
Audience: All
Type: Task
The existing documentation might contain helpful source material that you can pull into this doc change. See recommendations for the existing (at the time of the CNCF tech doc analysis) etcd technical documentation pages:
https://github.com/cncf/techdocs/blob/main/assessments/0010-etcd/etcd-implementation.md/#general-reorganization
🎤 Context
This issue tracks recommended changes resulting from an analysis of the etcd documentation commissioned by CNCF. The analysis and supporting documents are here: https://github.com/cncf/techdocs/tree/main/assessments/0010-etcd/
✌️ Possible Implementation
Related material in the current doc:
The text was updated successfully, but these errors were encountered: