Skip to content

Documentation Improvements #215

Open
@batpad

Description

@batpad

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).

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

Status

No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions