Skip to content

Docs: Fix user guide / improvements / explaining networking better for Kubernetes conversion #1577

@cdrage

Description

@cdrage

A set of improvements for the user guide:

User guide updates:

  • Tell the user that they should be using the most up-to-date compose spec (no passing in v2 or v3, etc.)
  • Explain networking / ingress / load balancing better. Our documentation is awful for this and this is where most of our issues / questions come from. Explain it better and tell the user what needs to be done (for example... why we deploy Deployment, and that we can choose to deploy replicaset, deploymentset, etc.), also explain: Can't configure ports property to include hostPort in Kind: Deployment #1545
  • Make example "outputs" smaller on the user guide
  • Add section about how to convert it all into ONE file / group containers into one pod
  • Extensive networking example
  • Fix issue with label table not showing well
  • In the label table, have it "link" via markdown to each clickable section to showcase examples.
  • Emphasis on that "labels" are to get you closer to 100% conversion (kompose takes you to 99%)

Conversion doc:

  • Update the conversion doc with ALL new Compose values (there are some missing)
  • Fix formatting (can't really view it well..)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions