kompose icon indicating copy to clipboard operation
kompose copied to clipboard

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

Open cdrage opened this issue 2 years ago • 8 comments

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: https://github.com/kubernetes/kompose/issues/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..)

cdrage avatar Feb 08 '23 21:02 cdrage

/assign

cdrage avatar Feb 13 '23 13:02 cdrage

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar May 14 '23 14:05 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle rotten
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot avatar Jun 13 '23 14:06 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

k8s-triage-robot avatar Jul 13 '23 14:07 k8s-triage-robot

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Jul 13 '23 14:07 k8s-ci-robot

/remove-lifecycle rotten

AhmedGrati avatar Jul 13 '23 19:07 AhmedGrati

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Apr 15 '24 23:04 k8s-triage-robot

/remove-lifecycle stale

cdrage avatar Apr 16 '24 15:04 cdrage