mirror of https://github.com/cncf/techdocs.git
41 lines
1.8 KiB
Markdown
41 lines
1.8 KiB
Markdown
---
|
|
title: _PROJECT_ Issue
|
|
tags: _PROJECT_
|
|
---
|
|
|
|
<!-- This template provides one possible format for the individual issues filed in the Issues of a project repository. Within the CNCF tech docs repo, include all issues in one document, `_PROJECT_-issues.md`. See any completed analysis for an example. -->
|
|
|
|
# Overview
|
|
|
|
<!-- Summarize the documentation changes prescribed by this issue. -->
|
|
|
|
Audience: <!-- Provide the user role to which the issue is most applicable. -->
|
|
|
|
Type: <!-- What type of documentation topic the change affects. One of Task, Reference, or Conceptual. -->
|
|
|
|
# Context
|
|
|
|
<!-- This is boilerplate text linking back to the doc analysis. -->
|
|
|
|
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
|
|
|
|
<!-- Include a bullet list of links to pages that are affected by the change: -->
|
|
|
|
Related material in the current doc:
|
|
- https://github.com/_PROJECT_/website/tree/main/content/en/docs/v3.5/tutorials
|
|
|
|
<!-- Describe in detail a suggested way to achieve the goals of the issue. This should be specific enough to provide a contributor with a recipe for making the change; however, the contributor should feel free to solve the problem differently if they have an idea how it should be done. -->
|
|
|
|
Suggested changes: <!-- (example) -->
|
|
|
|
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.)
|
|
|