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

Document Quickstart #18

Open
okamidash opened this issue Feb 1, 2021 · 0 comments
Open

Document Quickstart #18

okamidash opened this issue Feb 1, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@okamidash
Copy link
Member

A Quickstart is a great way to gather new users and help them get up and running.
A great example is the ceph-ansible documentation.

I should aim to do the following within the Quickstart:

  • Explain pre-requisites (DNS endpoint, oVirt, etc)
  • Provide a running example
  • List the required variables (with links)
  • List optional, but useful variables (with links)
@okamidash okamidash added the documentation Improvements or additions to documentation label Feb 1, 2021
@okamidash okamidash self-assigned this Feb 1, 2021
@okamidash okamidash added this to the Release 1.0 milestone Feb 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant