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

Revise the installation guide #770

Open
Tracked by #766 ...
dwelsch-esi opened this issue Feb 21, 2024 · 0 comments
Open
Tracked by #766 ...

Revise the installation guide #770

dwelsch-esi opened this issue Feb 21, 2024 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@dwelsch-esi
Copy link
Contributor

dwelsch-esi commented Feb 21, 2024

Overview

In the introduction to the installation instructions, briefly describe why a user should prefer using one installation procedure over another. Distinguish between production installations and local clusters for development or demo purposes. Include a link to the page for setting up a local cluster.

Consider separating the install procedures and putting each on its own separate page.

Audience: Standalone 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:

@dwelsch-esi dwelsch-esi changed the title Consolidate all reference information Revise the installation guide Mar 8, 2024
@nate-double-u nate-double-u added enhancement New feature or request help wanted Extra attention is needed labels Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants