You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>Write articles on Kapitan and share your way of working. Inspire others, and reach out to have your article published / endorsed by us.</p>
1928
1928
<h2id="this-website">This Website</h2>
1929
1929
<p>Find something odd? Let us know or change it yourself: you can edit pages of this website on Github by clicking the pencil icon at the top right of this page!</p>
<h2id="update-documentation">Update documentation<ahref="https://github.com/kapicorp/kapitan/actions/workflows/documentation.yml"><imgalt="Build and deploy documentation" src="https://github.com/kapicorp/kapitan/actions/workflows/documentation.yml/badge.svg" /></a></h2>
1931
1931
<p>We use <ahref="https://www.mkdocs.org/">mkdocs</a> to generate our gh-pages from <code>.md</code> files under docs/ folder.</p>
1932
1932
<p>Updating our gh-pages is therefore a two-step process.</p>
1933
1933
<h3id="update-the-markdown">Update the markdown</h3>
@@ -1938,11 +1938,7 @@ <h3 id="update-the-markdown">Update the markdown</h3>
1938
1938
<li>Now the documentation site should be available at <ahref="http://127.0.0.1:8000"><code>localhost:8000</code></a>.</li>
1939
1939
</ol>
1940
1940
<h3id="submit-a-pr">Submit a PR</h3>
1941
-
<p>Once the above PR has been merged, use <code>mkdocs gh-deploy</code> command to push the commit that updates the site content to your own gh-pages branch. Make sure that you already have this gh-pages branch in your fork that is up-to-date with our gh-pages branch such that the two branches share the commit history (otherwise Github would not allow PRs to be created).</p>
1942
-
<divclass="highlight"><pre><span></span><code># locally, on master branch (which has your updated docs)
1943
-
COMMIT_MSG="your commit message to replace" make mkdocs_gh_deploy
1944
-
</code></pre></div>
1945
-
<p>After it's pushed, create a PR that targets our gh-pages branch from your gh-pages branch.</p>
1941
+
<p>Once the above PR has been merged, our CI will deploy your docs automatically. </p>
0 commit comments