Conversation
Signed-off-by: = <[email protected]>
iiamabby
force-pushed
the
describe-etcd-roles
branch
from
8894bb9 to
8c05d2d
Compare
There was a problem hiding this comment.
Hey @dwelsch-esi, @iiamabby - Having a look at the deploy preview for this change it feels confusing to have both a "Quickstart" and "Start here" section?
|
Hey @jmhbnz possibly change to "Overview" instead of "Start here"? |
|
This has to wait on having some place for the roles to link to, no? |
|
A suggestion: The titles ("Quickstart", "What's my role?", ...) should mirror the left-side menu and the page titles, but you can add short descriptions and headings to orient readers. Especially if this is the doc landing page, a bullet list might not give sufficient information to a new user seeing the docs for the first time. Here's an example of how this might go: v3.6.0 docsGetting StartedQuickstart - Get a local instance of etcd running in less than five minutes What's my role? - Decide what documentation you need based on your use cases Demo - See what etcd can do Install - Build from source or install pre-built binaries Technical overview - learn about etcd User GuidesTutorials - Instructions for specific scenarios Metrics Reporting bugs Tuning Discovery service protocol ReferenceFAQ Libraries and tools Logging conventions Golang modules ... and so on |
jberkus
left a comment
jberkus
left a comment
There was a problem hiding this comment.
Couple of text/format things. Also, see questions/comments in discussion.
| --- | ||
| title: Start here | ||
| weight: 900 | ||
| description: User roles and Persona's |
There was a problem hiding this comment.
| description: User roles and Persona's | |
| description: User Roles and Personas |
|
|
||
| ## Evaluator | ||
| A technical decision-maker or architect evaluating whether etcd is suitable for their product, project, or organization. | ||
| #### Use Cases |
There was a problem hiding this comment.
why the level 4 header here? Shouldn't it be level 3?
| weight: 900 | ||
| description: User roles and Persona's | ||
| --- | ||
|
|
There was a problem hiding this comment.
This needs to start off with an introduction, no?
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: iiamabby The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hey, I think this is going to work better if we create a feature branch for working on these docs. What you have there, in terms of user roles and cases is great, but it needs a bunch of supporting text and reorganization before we can merge it into Main. |
5 participants
This PR pertains to issue #780 and also the umbrella issue #766
Working on describing the 4 user roles defined in the initial analysis and implementation plan for the
etcddoc updates.To note: the initial implementation plan requests a link to each user workflow / tasks for each user group (#765).
These are currently been developed and improved at the moment, for now they direct to the original
tutorialspage.Any suggestions / feedback welcome as always.