diff --git a/site/content/en/community/_index.md b/site/content/en/community/_index.md deleted file mode 100644 index d4f2de638..000000000 --- a/site/content/en/community/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Community -menu: - main: - weight: 20 ---- - - diff --git a/site/content/en/contribute/_index.md b/site/content/en/contribute/_index.md index ef9e3b1fd..a50cbc78c 100644 --- a/site/content/en/contribute/_index.md +++ b/site/content/en/contribute/_index.md @@ -1,23 +1,8 @@ - --- title: "Contribute" linkTitle: "Contribute" +type: docs menu: main: weight: 30 --- - -{{% pageinfo %}} -This is a placeholder page that shows you how to use this template site. -{{% /pageinfo %}} - - -This section is where the user documentation for your project lives - all the information your users need to understand and successfully use your project. - -For large documentation sets we recommend adding content under the headings in this section, though if some or all of them don’t apply to your project feel free to remove them or add your own. You can see an example of a smaller Docsy documentation site in the [Docsy User Guide](https://docsy.dev/docs/), which lives in the [Docsy theme repo](https://github.com/google/docsy/tree/master/userguide) if you'd like to copy its docs section. - -Other content such as marketing material, case studies, and community updates should live in the [About](/about/) and [Community](/community/) pages. - -Find out how to use the Docsy theme in the [Docsy User Guide](https://docsy.dev/docs/). You can learn more about how to organize your documentation (and how we organized this site) in [Organizing Your Content](https://docsy.dev/docs/best-practices/organizing-content/). - - diff --git a/site/content/en/contribute/bugs/_index.md b/site/content/en/contribute/bugs/_index.md new file mode 100644 index 000000000..44324b8f5 --- /dev/null +++ b/site/content/en/contribute/bugs/_index.md @@ -0,0 +1,57 @@ +--- +title: "Filing Bugs" +linkTitle: "Filing Bugs" +type: docs +weight: 10 +description: > + How to file bugs and fix Kustomize bugs +--- + +[krusty package]: https://github.com/kubernetes-sigs/kustomize/tree/master/api/krusty +[reusable custom transformer test]: https://github.com/kubernetes-sigs/kustomize/tree/master/api/krusty/customconfigreusable_test.go +[example PR]: https://github.com/kubernetes-sigs/kustomize/pull/4683 + +File [issues](https://github.com/kubernetes-sigs/kustomize/issues) as desired, but if you've found a problem +with how `kustomize build` works, please report: + +* the output of `kustomize version`, +* the input (the content of `kustomization.yaml` + and any files it refers to), +* the expected YAML output. + +## If you have `go` installed + +kustomize has a simple test harness in the [krusty +package] for specifying a kustomization's input and the +expected output. + +Copy one of those tests, e.g. this [reusable custom +transformer test], to a new test file in the +krusty package. + +Insert the inputs you want to use, and run it as +you'd run the reusable custom transformer test: + +``` +(cd api; go test -run TestReusableCustomTransformers ./krusty) +``` + +The output will demonstrate the bug or missing feature. + +Record this output in the test file in a call to +`AssertActualEqualsExpected`, per all the other tests +in the [krusty package]. This makes the test pass, +albeit with output demonstrating behavior you +presumably want to change. + +Send the new test in a PR, along with commentary (in +the test) on what you'd prefer to see. You can refer to this [example PR] + +The person who fixes the bug then has a clear bug +reproduction and a test to modify when the bug is +fixed. + +Any bug fix first requires a test demonstrating the bug +(so we have permanent regression coverage), so if the +_bug reporter_ does this, it saves time and avoids +misunderstandings. diff --git a/site/content/en/contribute/community/_index.md b/site/content/en/contribute/community/_index.md new file mode 100644 index 000000000..b19b1e0b3 --- /dev/null +++ b/site/content/en/contribute/community/_index.md @@ -0,0 +1,23 @@ +--- +title: "Community Engagment" +linkTitle: "Community" +type: docs +weight: 20 +description: > + Joining SIG-CLI and the Kubernetes community +--- + +[CLI special interest group]: https://github.com/kubernetes/community/tree/master/sig-cli#cli-special-interest-group +[contributor roles]: https://github.com/kubernetes/community/blob/master/community-membership.md#community-membership +[mailing list]: https://groups.google.com/forum/#!forum/kubernetes-sig-cli +[bi-weekly meetings]: https://github.com/kubernetes/community/tree/master/sig-cli#meetings +[slack channel]: https://kubernetes.slack.com/messages/sig-cli + +Kustomize is a sub project of the Kubernetes [CLI special interest group] and follows the Kubernetes +project [contributor roles]. + +If you are interested in contributing towards Kustomize or getting more involved with the community: + +- join the [mailing list] and reach out +- join the [slack channel] and reach out +- attend one of the [bi-weekly meetings] (alternating Wednesdays) diff --git a/site/content/en/contribute/features/_index.md b/site/content/en/contribute/features/_index.md new file mode 100644 index 000000000..d5ebf3e61 --- /dev/null +++ b/site/content/en/contribute/features/_index.md @@ -0,0 +1,10 @@ +--- +title: "Contributing Features" +linkTitle: "Contributing Features" +type: docs +weight: 30 +description: > + How to contribute features +--- + +For feature proposals, please refer to [Kustomize Enhancement Proposal Processes](https://github.com/kubernetes-sigs/kustomize/tree/master/proposals) documentation diff --git a/site/content/en/contribute/howitworks/_index.md b/site/content/en/contribute/howitworks/_index.md new file mode 100644 index 000000000..30078e23f --- /dev/null +++ b/site/content/en/contribute/howitworks/_index.md @@ -0,0 +1,26 @@ +--- +title: "Writing Code" +linkTitle: "Writing Code" +type: docs +weight: 40 +description: > + Background information to help orient newcomers to the Kustomize codebase +--- + +{{< alert color="success" title="Workspace mode" >}} +Kustomize supports go workspace mode, so if adding locally modified modules, remember to also add it to the [go.work](https://github.com/kubernetes-sigs/kustomize/blob/master/go.work) file. + +{{< /alert >}} + +#### Build command + +All kustomize commands can be found in [kustomize/commands](https://github.com/kubernetes-sigs/kustomize/tree/master/kustomize/commands) + +Running `kustomize build` triggers the [NewCmdBuild](https://github.com/kubernetes-sigs/kustomize/blob/master/kustomize/commands/build/build.go#L65), which does the following: + +- creates a [Kustomizer](https://github.com/kubernetes-sigs/kustomize/blob/master/kustomize/commands/build/build.go#L77) instance + +- calls [Run](https://github.com/kubernetes-sigs/kustomize/blob/482e8930fc256672afd4ff5d531ec8fe80d35119/api/krusty/kustomizer.go#L53-L543) to perform the kustomization + +- returns the [kustomization output as yaml](https://github.com/kubernetes-sigs/kustomize/blob/master/kustomize/commands/build/build.go#L89-L97) + diff --git a/site/content/en/contribute/mac/_index.md b/site/content/en/contribute/mac/_index.md new file mode 100644 index 000000000..ebb6ddbb4 --- /dev/null +++ b/site/content/en/contribute/mac/_index.md @@ -0,0 +1,22 @@ +--- +title: "MacOS Dev Guide" +linkTitle: "MacOS Dev Guide" +type: docs +weight: 50 +description: > + How to develop on MacOS +--- + +First install the tools to build and run tests + +### Install go 1.18 + +[Instructions](https://golang.org/doc/install) + +Add `go` to your PATH + +### Install tools + +```sh +make install-tools +``` diff --git a/site/content/en/faq/_index.md b/site/content/en/faq/_index.md new file mode 100644 index 000000000..7ca1a4510 --- /dev/null +++ b/site/content/en/faq/_index.md @@ -0,0 +1,12 @@ +--- +title: "FAQ" +linkTitle: "FAQ" +type: docs +menu: + main: + weight: 70 +--- + + diff --git a/site/content/en/faq/eschewedfeatures.md b/site/content/en/faq/eschewedfeatures.md new file mode 100644 index 000000000..a68e3f629 --- /dev/null +++ b/site/content/en/faq/eschewedfeatures.md @@ -0,0 +1,12 @@ +--- +title: "Eschewed Features" +linkTitle: "Eschewed Features" +type: docs +weight: 99 +description: > + Eschewed Features +--- + + diff --git a/site/content/en/faq/versioningPolicy.md b/site/content/en/faq/versioningPolicy.md new file mode 100644 index 000000000..bd206928f --- /dev/null +++ b/site/content/en/faq/versioningPolicy.md @@ -0,0 +1,9 @@ +--- +title: "Versioning Policy" +linkTitle: "Versioning Policy" +weight: 99 +type: docs +--- +