kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-06-13 01:50:55 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

update docs site

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

82
docs/contributing/docs/index.html
View File

@@ -403,20 +403,6 @@
<nav id="TableOfContents">
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#development">Development</a></li>
<li><a href="#publishing">Publishing</a></li>
<li><a href="#publishing-docs-to-your-kustomize-fork">Publishing docs to your kustomize fork</a>
<ul>
<li><a href="#setup-github-pages-for-the-fork">Setup GitHub Pages for the fork</a></li>
<li><a href="#publish-to-the-forks-github-pages">Publish to the fork&rsquo;s GitHub Pages</a></li>
</ul>
</li>
</ul>
</nav>
</div>
@@ -453,71 +439,7 @@
<h1>Writing Docs</h1>
<div class="lead">How to make Kustomize docs contributions</div>
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/contributing/kustomize/docs" />
<p>Kustomize uses <a href="https://www.docsy.dev">Docsy</a> for the site, and was
forked from the <a href="https://github.com/google/docsy-example">docsy-example</a></p>
<h2 id="prerequisites">Prerequisites</h2>
<ul>
<li><a href="https://gohugo.io/getting-started/installing/#fetch-from-github">Install hugo</a></li>
<li>Clone kustomize
<ul>
<li><code>git clone git@github.com:kubernetes-sigs/kustomize &amp;&amp; cd kustomize/</code></li>
</ul>
</li>
</ul>
<h2 id="development">Development</h2>
<p>The doc input files are in the <code>site</code> directory. The site can be hosted locally using
<code>hugo serve</code>.</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell"><span style="color:#204a87">cd</span> site/
hugo serve
</code></pre></div><div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">...
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/kustomize/ <span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#204a87">bind</span> address 127.0.0.1<span style="color:#ce5c00;font-weight:bold">)</span>
</code></pre></div><h2 id="publishing">Publishing</h2>
<p>Hugo compiles the files under <code>site</code> Hugo into html which it puts in the <code>docs</code> folder:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell"><span style="color:#204a87">cd</span> site/
hugo
</code></pre></div><div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell"> <span style="color:#000;font-weight:bold">|</span> EN
-------------------+-----
Pages <span style="color:#000;font-weight:bold">|</span> <span style="color:#0000cf;font-weight:bold">99</span>
Paginator pages <span style="color:#000;font-weight:bold">|</span> <span style="color:#0000cf;font-weight:bold">0</span>
Non-page files <span style="color:#000;font-weight:bold">|</span> <span style="color:#0000cf;font-weight:bold">0</span>
Static files <span style="color:#000;font-weight:bold">|</span> <span style="color:#0000cf;font-weight:bold">47</span>
Processed images <span style="color:#000;font-weight:bold">|</span> <span style="color:#0000cf;font-weight:bold">0</span>
Aliases <span style="color:#000;font-weight:bold">|</span> <span style="color:#0000cf;font-weight:bold">2</span>
Sitemaps <span style="color:#000;font-weight:bold">|</span> <span style="color:#0000cf;font-weight:bold">1</span>
Cleaned <span style="color:#000;font-weight:bold">|</span> <span style="color:#0000cf;font-weight:bold">0</span>
</code></pre></div><p>Add the <code>site/</code> and <code>docs/</code> folders to a commit, then create a PR.</p>
<h2 id="publishing-docs-to-your-kustomize-fork">Publishing docs to your kustomize fork</h2>
<p>It is possible to have the kustomize docs published to your forks github pages.</p>
<h3 id="setup-github-pages-for-the-fork">Setup GitHub Pages for the fork</h3>
<ol>
<li>Go to the <em>forked repo&rsquo;s</em> <strong>Settings</strong> tab
<ul>
<li>e.g. <a href="https://github.com/pwittrock/kustomize">https://github.com/pwittrock/kustomize</a></li>
</ul>
</li>
<li>Go to the <strong>GitHub Pages</strong> section</li>
<li>Set the source to master branch <strong>/docs folder</strong></li>
</ol>
<h3 id="publish-to-the-forks-github-pages">Publish to the fork&rsquo;s GitHub Pages</h3>
<div class="pageinfo pageinfo-info">
<p>Changes must be pushed to the fork&rsquo;s <strong>master branch</strong> to be served as the fork&rsquo;s GitHub Page.</p>
</div>
<ol>
<li>Make a change to a file under <code>site/content</code></li>
<li>Run <code>hugo</code> from the <code>site/</code> directory</li>
<li>Add the <code>site</code> and <code>docs</code> directories to the <strong>master branch</strong></li>
<li>Commit and push the changes to the <em>remote fork&rsquo;s</em> <strong>master branch</strong></li>
<li>After a few minutes, the docs should be served from the fork&rsquo;s GitHub Page
<ul>
<li>e.g. <a href="https://pwittrock.github.io/kustomize/">https://pwittrock.github.io/kustomize/</a></li>
</ul>
</li>
</ol>
<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">
@@ -547,7 +469,7 @@ hugo
<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>