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.

Sign up for GitHub

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

Jump to bottom

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

Closed
10 tasks done
cdrage opened this issue Feb 8, 2023 · 8 comments · Fixed by #1882
Closed
10 tasks done

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

cdrage opened this issue Feb 8, 2023 · 8 comments · Fixed by #1882
Assignees
@cdrage

Comments

@cdrage
Copy link
Member

cdrage commented Feb 8, 2023 •
edited

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..)
@cdrage
Copy link
Member Author

cdrage commented Feb 13, 2023

/assign

@k8s-triage-robot
Copy link

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-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 14, 2023
@k8s-triage-robot
Copy link

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-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jun 13, 2023
@k8s-triage-robot
Copy link

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-ci-robot k8s-ci-robot closed this as not planned Won't fix, can't repro, duplicate, stale Jul 13, 2023
@k8s-ci-robot
Copy link
Contributor

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

@AhmedGrati AhmedGrati reopened this Jul 13, 2023
@AhmedGrati
Copy link
Contributor

/remove-lifecycle rotten

@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Jul 13, 2023
@k8s-triage-robot
Copy link

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-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 15, 2024
@cdrage
Copy link
Member Author

cdrage commented Apr 16, 2024

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 16, 2024
cdrage added a commit to cdrage/kompose that referenced this issue May 29, 2024
@cdrage
docs: update user guide
4fcb0af 
#### What type of PR is this?

<!--
Add one of the following kinds:
/kind bug
/kind cleanup
/kind feature
-->
/kind documentation

#### What this PR does / why we need it:

Updates the user guide completely revamp it / describe each label.

#### Which issue(s) this PR fixes:
<!--
*Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->

Closes kubernetes#1584
Closes kubernetes#1577

#### Special notes for your reviewer:
Signed-off-by: Charlie Drage <charlie@charliedrage.com>

Please check the docs examples / each label that it's okay!
@cdrage cdrage mentioned this issue May 29, 2024
Merged
cdrage added a commit to cdrage/kompose that referenced this issue May 29, 2024
@cdrage
docs: update user guide
7653bd4 
#### What type of PR is this?

<!--
Add one of the following kinds:
/kind bug
/kind cleanup
/kind feature
-->
/kind documentation

#### What this PR does / why we need it:

Updates the user guide completely revamp it / describe each label.

#### Which issue(s) this PR fixes:
<!--
*Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->

Closes kubernetes#1584
Closes kubernetes#1577

#### Special notes for your reviewer:
Signed-off-by: Charlie Drage <charlie@charliedrage.com>

Please check the docs examples / each label that it's okay!
cdrage added a commit to cdrage/kompose that referenced this issue May 29, 2024
@cdrage
docs: update user guide
92f03ec 
#### What type of PR is this?

<!--
Add one of the following kinds:
/kind bug
/kind cleanup
/kind feature
-->
/kind documentation

#### What this PR does / why we need it:

Updates the user guide completely revamp it / describe each label.

#### Which issue(s) this PR fixes:
<!--
*Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->

Closes kubernetes#1584
Closes kubernetes#1577

#### Special notes for your reviewer:
Signed-off-by: Charlie Drage <charlie@charliedrage.com>

Please check the docs examples / each label that it's okay!
cdrage added a commit to cdrage/kompose that referenced this issue May 30, 2024
@cdrage
docs: update user guide
dbf420f 
#### What type of PR is this?

<!--
Add one of the following kinds:
/kind bug
/kind cleanup
/kind feature
-->
/kind documentation

#### What this PR does / why we need it:

Updates the user guide completely revamp it / describe each label.

#### Which issue(s) this PR fixes:
<!--
*Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->

Closes kubernetes#1584
Closes kubernetes#1577

#### Special notes for your reviewer:
Signed-off-by: Charlie Drage <charlie@charliedrage.com>

Please check the docs examples / each label that it's okay!
TessaIO added a commit that referenced this issue Jun 2, 2024
@cdrage @TessaIO
docs: update user guide (#1882)
6a5c646 
* docs: update user guide

#### What type of PR is this?

<!--
Add one of the following kinds:
/kind bug
/kind cleanup
/kind feature
-->
/kind documentation

#### What this PR does / why we need it:

Updates the user guide completely revamp it / describe each label.

#### Which issue(s) this PR fixes:
<!--
*Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->

Closes #1584
Closes #1577

#### Special notes for your reviewer:
Signed-off-by: Charlie Drage <charlie@charliedrage.com>

Please check the docs examples / each label that it's okay!

* Update docs/user-guide.md

Co-authored-by: TessaIO <ahmedgrati1999@gmail.com>

* Update docs/user-guide.md

Co-authored-by: TessaIO <ahmedgrati1999@gmail.com>

* Update docs/user-guide.md

Co-authored-by: TessaIO <ahmedgrati1999@gmail.com>

* update capitalization

Signed-off-by: Charlie Drage <charlie@charliedrage.com>

---------

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
Co-authored-by: TessaIO <ahmedgrati1999@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cdrage cdrage

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: update user guide cdrage/kompose
4 participants
@cdrage @k8s-ci-robot @AhmedGrati @k8s-triage-robot