update docs site

This commit is contained in:
Phillip Wittrock
2020-11-11 08:30:00 -08:00
parent 71b763888c
commit afff3ce5ab
49 changed files with 197 additions and 7846 deletions

View File

@@ -439,39 +439,7 @@
<h1>Filing Bugs</h1>
<div class="lead">How to file bugs and fix Kustomize bugs</div>
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/contributing/kustomize/bugs" />
<p>File issues as desired, but if you&rsquo;ve found a problem
with how <code>kustomize build</code> works, please report</p>
<ul>
<li>the output of <code>kustomize version</code>,</li>
<li>the input (the content of <code>kustomization.yaml</code>
and any files it refers to),</li>
<li>the expected YAML output.</li>
</ul>
<h2 id="if-you-have-go-installed">If you have <code>go</code> installed</h2>
<p>kustomize has a simple test harness in the <a href="https://github.com/kubernetes-sigs/kustomize/tree/master/api/krusty">krusty
package</a> for specifying a kustomization&rsquo;s input and the
expected output.</p>
<p>Copy one of those tests, e.g. this <a href="https://github.com/kubernetes-sigs/kustomize/tree/master/api/krusty/customconfigreusable_test.go">reusable custom
transformer test</a>, to a new test file in the
krusty package.</p>
<p>Insert the inputs you want to use, and run it as
you&rsquo;d run the reusable custom transformer test:</p>
<pre><code>(cd api; go test -run TestReusableCustomTransformers ./krusty)
</code></pre><p>The output will demonstrate the bug or missing feature.</p>
<p>Record this output in the test file in a call to
<code>AssertActualEqualsExpected</code>, per all the other tests
in the <a href="https://github.com/kubernetes-sigs/kustomize/tree/master/api/krusty">krusty package</a>. This makes the test pass,
albeit with output demonstrating behavior you
presumably want to change.</p>
<p>Send the new test in a PR, along with commentary (in
the test) on what you&rsquo;d prefer to see.</p>
<p>The person who fixes the bug then has a clear bug
reproduction and a test to modify when the bug is
fixed.</p>
<p>Any bug fix first requires a test demonstrating the bug
(so we have permanent regression coverage), so if the
<em>bug reporter</em> does this, it saves time and avoids
misunderstandings.</p>
<p>Moved to <a href="https://github.com/kubernetes-sigs/cli-experimental">https://github.com/kubernetes-sigs/cli-experimental</a></p>
<div class="section-index">
@@ -501,7 +469,7 @@ misunderstandings.</p>
<div class="text-muted mt-5 pt-3 border-top">Last modified November 4, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/0834e152b203ffeccfbbf1ddd3c1f49debdac341">Redirect kustomize docs to the new unified site. (0834e152)</a>
<div class="text-muted mt-5 pt-3 border-top">Last modified November 11, 2020: <a href="https://github.com/kubernetes-sigs/kustomize/commit/71b763888cad614abb44b3086e291fe72d601080">Remove duplicate kustomize docs content (71b76388)</a>
</div>
</div>