etcd-io / website

etcd.io
https://etcd.io
Other
146 stars 295 forks source link

Convert tutorials to tasks #765

Open dwelsch-esi opened 8 months ago

dwelsch-esi commented 8 months ago

Overview

Rename the "Tutorials" section "Tasks". Split this Task section by user role and put the resulting two sections in their respective user guides: Developer and Operations.

Rename each task by removing "How to" and using the "-ing" verb form. Make steps in each task explicit; one-step tasks are okay.

Rewrite each task as step-by-step instructions for a single task in an individual description. The goal is to walk the user through the completion of the task. For example, the [How to access etcd][access-tutorial] tutorial should be two separate tasks: "Writing to etcd on the CLI" and "Reading from etcd on the CLI".

Audience: The user role to which the task most applies, probably either Developer or Operator.

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:

Suggested changes:

Use the following outline for each task:

celestehorgan commented 7 months ago

In preparation for the Contributor Fest docs hackathon, I've created the following sub-issues. @nate-double-u you can leave these off the issue tracker until the end of KubeCon EU, I think :)