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

kustomize docs tweaks

Browse Source
This commit is contained in:
Phillip Wittrock
2020-06-11 21:40:35 -07:00
parent 3012dd67ac
commit 589ddcb4fa
10 changed files with 467 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -350,6 +350,12 @@
<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>
@@ -400,17 +406,17 @@ forked from the <a href="https://github.com/google/docsy-example">docsy-example<
</li>
</ul>
<h2 id="development">Development</h2>
<p>The docs are in the <code>site</code> directory</p>
<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/
</code></pre></div><p>To view the docs run</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">hugo serve
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><p>and visit the URL that is printed</p>
<h2 id="publishing">Publishing</h2>
<p>The <code>site</code> content is compiled by Hugo into the <code>docs</code> folder using the hugo command:</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">hugo
</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>
@@ -421,7 +427,38 @@ Web Server is available at http://localhost:1313/kustomize/ <span style="color:#
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, and create a PR.</p>
</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>
<div class="section-index">