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

Documentation Improvements #215

Open
batpad opened this issue Jan 12, 2022 · 1 comment
Open

Documentation Improvements #215

batpad opened this issue Jan 12, 2022 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@batpad
Copy link
Member

batpad commented Jan 12, 2022

Various improvements to documentation:

  • Clarify recommended path for various use-cases - docker-compose vs. Helm chart.
  • Create a more streamlined, easy to follow, 10 minute "quickstart" guide for different scenarios:
    • Setup locally via docker-compose
    • Setup locally on minikube
    • Install onto AWS EKS cluster
    • Install onto GCP Kubernetes cluster
    • Install onto Azure Kubernetes cluster
  • Create detailed documentation for all values that can be customized in the values.yaml when deploying to a k8s cluster.
  • Write out recommended resource requirements for various use-cases.

Verify that quick-start guides all work.

As part of the documentation, it would also be great to clearly clarify the different use-cases for osm-seed and what the recommended way would be to support each one (alongwith which use-cases we may not really support).

@geohacker geohacker added the bug Something isn't working label Jan 12, 2022
@batpad
Copy link
Member Author

batpad commented Feb 3, 2022

Just making some notes going through the existing docs:

Just organizing these in a clear manner with an obvious reference from the main README would be super helpful to make things cler. Additionally, detailed documentation of customizable values should make this a lot easier to follow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: No status
Development

No branches or pull requests

2 participants