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

Describe user roles #852

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

iiamabby
Copy link
Contributor

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 etcd doc 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 tutorials page.

Any suggestions / feedback welcome as always.

@iiamabby iiamabby force-pushed the describe-etcd-roles branch from 8894bb9 to 8c05d2d Compare May 15, 2024 21:46
@iiamabby iiamabby changed the title Described user roles Describe user roles May 15, 2024
Copy link
Member

@jmhbnz jmhbnz left a comment

Choose a reason for hiding this comment

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

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?

image

@iiamabby
Copy link
Contributor Author

Hey @jmhbnz possibly change to "Overview" instead of "Start here"?

@jmhbnz
Copy link
Member

jmhbnz commented Jul 22, 2024

Hey @jmhbnz possibly change to "Overview" instead of "Start here"?

Hey @iiamabby I would suggest calling the page "Personas" or "User roles" as that is what the page seems to contain, thanks!

@jberkus
Copy link
Contributor

jberkus commented Aug 26, 2024

This has to wait on having some place for the roles to link to, no?

@dwelsch-esi
Copy link
Contributor

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 docs

Getting Started

Quickstart - 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 Guides

Tutorials - Instructions for specific scenarios

Metrics

Reporting bugs

Tuning

Discovery service protocol

Reference

FAQ

Libraries and tools

Logging conventions

Golang modules

... and so on

Copy link
Contributor

@jberkus jberkus left a comment

Choose a reason for hiding this comment

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

Couple of text/format things. Also, see questions/comments in discussion.

---
title: Start here
weight: 900
description: User roles and Persona's
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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
Copy link
Contributor

Choose a reason for hiding this comment

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

why the level 4 header here? Shouldn't it be level 3?

weight: 900
description: User roles and Persona's
---

Copy link
Contributor

Choose a reason for hiding this comment

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

This needs to start off with an introduction, no?

@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: iiamabby
Once this PR has been reviewed and has the lgtm label, please assign spzala for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jberkus
Copy link
Contributor

jberkus commented Aug 27, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants