techdocs/docs/analysis/resources/issue-template.md

title	tags
_PROJECT_ Issue	_PROJECT_

Overview

Audience:

Type:

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/00NN-project/

Possible Implementation

Related material in the current doc:

• https://github.com/PROJECT/website/tree/main/content/en/docs/v3.5/tutorials

Suggested changes:

Use the following outline to write a procedure for each task:

• Prerequisites (bullet list of prerequisite conditions, if any)
• Procedure
  1. Step 1 (keep steps discrete and atomic. Put command-line input and expected output in a code block.)
  2. Step 2 ...
• Result (optional; describe output or side effects if they're notable or unexpected.)