Skip to content

Consolidate kustomize documentation #4338

@natasha41575

Description

@natasha41575

Now that the domain kustomize.io has been transferred to us, we should figure out what we want to do with all of our fragmented documentation.

There's the outdated kustomize.io, the small and very hard to find kustomize section on kubernetes.io, our core docs on kubernetes-sigs.github.io/kustomize, and the examples in this repo. We should consolidate these docs into a single, easy to find place.

It would be nice to have everything cleanly on kustomize.io, with links or redirects to it from the other websites. We like having the examples in this repo as tests, and I imagine it would be possible to have all the doc contents and examples and tests in this repo - perhaps under a site directory - and point that to kustomize.io. Though we now have the domain, the source code for kustomize.io currently lives in a repository owned by Replicated. If we wish to change or contribute to that code, we should move it over to a repository owned by CNCF.

It would also be helpful to have documentation for kustomize commands (see #3464)

This would be a decently sized project, and it is likely we would need a dedicated person that can spend time on this.

/kind documentation
/triage accepted

cc @KnVerey @yuwenma @mikebz

Contribution process

To help us see the work to be done and coordinate more easily, we've put together a spreadsheet. Everyone on the SIG CLI mailing list should be able to edit it. If you're interested in contributing to this effort, please:

  1. Consult the spreadsheet to find content that hasn't been moved yet. Give priority to content from the old site (as opposed to the section at the bottom with other repos) since getting that moved is the MVP for launching the new site.
  2. Assign yourself to the specific page(s) you're tackling by writing your name in the "Assignee" column.
  3. Move the content into the appropriate place in Kustomize's site/content/en directory.
  4. Review the content, keeping any comments from the spreadsheet in mind. In particular, please make sure that all links are live and that kustomize build can successfully be run with the latest version of Kustomize on any examples given (if it doesn't and the fix isn't obvious, just flag it on the PR). Other improvements jump out at you? Feel free to make those too!
  5. When your PR is ready, tag maintainers as usual, but please also link it in the spreadsheet. Please confirm in your PR description that you have validated the links and examples. We'll take your word for it, which will speed up the review process.
  6. When your PR merges, check the "merged" box in the spreadsheet so we can track progress.

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.triage/acceptedIndicates an issue or PR is ready to be actively worked on.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions