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

Improve docs for getting started with Kustomize #3973

Open
KnVerey opened this issue Jun 9, 2021 · 25 comments
Open

Improve docs for getting started with Kustomize #3973

KnVerey opened this issue Jun 9, 2021 · 25 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@KnVerey
Copy link
Contributor

KnVerey commented Jun 9, 2021

We would like to have more entry-level tutorials as part of the Kustomize documentation, both to help users get started and to showcase best practices. Ideally these would include some video tutorials!

/help-wanted
/triage accepted
/kind documentation

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. kind/documentation Categorizes issue or PR as related to documentation. labels Jun 9, 2021
@KnVerey
Copy link
Contributor Author

KnVerey commented Jun 9, 2021

/help

@k8s-ci-robot
Copy link
Contributor

@KnVerey:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

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 k8s-ci-robot added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Jun 9, 2021
@mikebz
Copy link
Contributor

mikebz commented Jun 10, 2021

where would this end up? kustomize.io?

@KnVerey
Copy link
Contributor Author

KnVerey commented Jun 10, 2021

There's an effort just getting started to figure out how to migrate some/more/all (TBD) of the SIG-CLI site into kubernetes.io, but for now our core docs are at https://kubernetes-sigs.github.io/kustomize/, so that's where the content would go in the near term. It is generated from https://github.com/kubernetes-sigs/cli-experimental.

@natasha41575
Copy link
Contributor

natasha41575 commented Jun 10, 2021

@KnVerey do you know who maintains kustomize.io and if we can contribute to it? There are some issues filed about how the tutorial on it is broken and considering it's the first link when people google search "kustomize" it's probably good if we keep an eye on it.

https://github.com/kubernetes-sigs/kustomize/issues?q=is%3Aissue+kustomize.io

@mikebz
Copy link
Contributor

mikebz commented Jun 10, 2021

we have created some infra into https://kpt.dev which seems to work pretty well. It seems like kustmomize.io is just the front page but if we want to have a MD driven doc site you can grab some code form kpt repo and use that.

@KnVerey
Copy link
Contributor Author

KnVerey commented Jun 15, 2021

FWIW the current site at https://kubernetes-sigs.github.io/kustomize/ is already generated from Markdown (Hugo) in https://github.com/kubernetes-sigs/cli-experimental.

@k8s-triage-robot
Copy link

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR 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 Sep 14, 2021
@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 and PRs 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 or PR as fresh with /remove-lifecycle rotten
  • Close this issue or PR 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 Oct 14, 2021
@natasha41575
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 Oct 14, 2021
@natasha41575
Copy link
Contributor

Related: #4338

@rob8714
Copy link
Contributor

rob8714 commented Mar 1, 2022

/assign @rob8714

@k8s-triage-robot
Copy link

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR 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 30, 2022
@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 and PRs 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 or PR as fresh with /remove-lifecycle rotten
  • Close this issue or PR 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 29, 2022
@KnVerey
Copy link
Contributor Author

KnVerey commented Jul 5, 2022

/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 5, 2022
@k8s-triage-robot
Copy link

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR 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 Oct 3, 2022
@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 and PRs 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 or PR as fresh with /remove-lifecycle rotten
  • Close this issue or PR 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 Nov 2, 2022
@rob8714
Copy link
Contributor

rob8714 commented Dec 3, 2022

/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 Dec 3, 2022
@rob8714
Copy link
Contributor

rob8714 commented Dec 3, 2022

@KnVerey unassigning this issue from myself since I don't have the time the contribute to it at the moment

@rob8714 rob8714 removed their assignment Dec 3, 2022
@Aisuko
Copy link

Aisuko commented Apr 11, 2023

I'd like to take this one.

@Aisuko
Copy link

Aisuko commented Apr 11, 2023

/assign @Aisuko

@mikebz
Copy link
Contributor

mikebz commented Apr 11, 2023

@Aisuko let me know when you have a plan for information architecture or hosting. Happy to contribute whenever we can.

@Aisuko
Copy link

Aisuko commented May 1, 2023

@Aisuko let me know when you have a plan for information architecture or hosting. Happy to contribute whenever we can.

Hi, @mikebz. I believe we can make it simple. If it can be s static site maybe more easier.

@Aisuko Aisuko removed their assignment May 1, 2023
@Aisuko
Copy link

Aisuko commented May 1, 2023

Unassign from me, the PRs are hard to get reviewed and merged. And I believe this issue needs more members from the kube-sig org involved in the process.

@k8s-triage-robot
Copy link

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

  • Confirm that this issue is still relevant with /triage accepted (org members only)
  • Close this issue with /close

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. and removed triage/accepted Indicates an issue or PR is ready to be actively worked on. labels Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

No branches or pull requests

7 participants