kustomize icon indicating copy to clipboard operation
kustomize copied to clipboard

Improve docs for getting started with Kustomize

Open KnVerey opened this issue 4 years ago • 25 comments

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

KnVerey avatar Jun 09 '21 18:06 KnVerey

/help

KnVerey avatar Jun 09 '21 20:06 KnVerey

@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 avatar Jun 09 '21 20:06 k8s-ci-robot

where would this end up? kustomize.io?

mikebz avatar Jun 10 '21 02:06 mikebz

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.

KnVerey avatar Jun 10 '21 15:06 KnVerey

@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

natasha41575 avatar Jun 10 '21 16:06 natasha41575

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.

mikebz avatar Jun 10 '21 16:06 mikebz

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.

KnVerey avatar Jun 15 '21 23:06 KnVerey

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-triage-robot avatar Sep 14 '21 00:09 k8s-triage-robot

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-triage-robot avatar Oct 14 '21 01:10 k8s-triage-robot

/remove-lifecycle rotten

natasha41575 avatar Oct 14 '21 01:10 natasha41575

Related: https://github.com/kubernetes-sigs/kustomize/issues/4338

natasha41575 avatar Dec 10 '21 00:12 natasha41575

/assign @rob8714

rob8714 avatar Mar 01 '22 20:03 rob8714

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-triage-robot avatar May 30 '22 20:05 k8s-triage-robot

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-triage-robot avatar Jun 29 '22 21:06 k8s-triage-robot

/remove-lifecycle rotten

KnVerey avatar Jul 05 '22 17:07 KnVerey

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-triage-robot avatar Oct 03 '22 17:10 k8s-triage-robot

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-triage-robot avatar Nov 02 '22 17:11 k8s-triage-robot

/remove-lifecycle rotten

rob8714 avatar Dec 03 '22 12:12 rob8714

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

rob8714 avatar Dec 03 '22 12:12 rob8714

I'd like to take this one.

Aisuko avatar Apr 11 '23 02:04 Aisuko

/assign @Aisuko

Aisuko avatar Apr 11 '23 02:04 Aisuko

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

mikebz avatar Apr 11 '23 19:04 mikebz

@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 avatar May 01 '23 02:05 Aisuko

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.

Aisuko avatar May 01 '23 02:05 Aisuko

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-triage-robot avatar Apr 30 '24 03:04 k8s-triage-robot