Skip to content

Commit 3fbfcd1

Browse files
author
mike-mkdocs-bot
committed
Deployed 37db467 to dev with MkDocs 1.6.1 and mike 2.1.3
1 parent 0f849d0 commit 3fbfcd1

File tree

2 files changed

+3
-7
lines changed

2 files changed

+3
-7
lines changed

dev/pages/contribute/documentation/index.html

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1927,7 +1927,7 @@ <h2 id="articles">Articles</h2>
19271927
<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>
19281928
<h2 id="this-website">This Website</h2>
19291929
<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>
1930-
<h2 id="update-documentation">Update documentation</h2>
1930+
<h2 id="update-documentation">Update documentation <a href="https://github.com/kapicorp/kapitan/actions/workflows/documentation.yml"><img alt="Build and deploy documentation" src="https://github.com/kapicorp/kapitan/actions/workflows/documentation.yml/badge.svg" /></a></h2>
19311931
<p>We use <a href="https://www.mkdocs.org/">mkdocs</a> to generate our gh-pages from <code>.md</code> files under docs/ folder.</p>
19321932
<p>Updating our gh-pages is therefore a two-step process.</p>
19331933
<h3 id="update-the-markdown">Update the markdown</h3>
@@ -1938,11 +1938,7 @@ <h3 id="update-the-markdown">Update the markdown</h3>
19381938
<li>Now the documentation site should be available at <a href="http://127.0.0.1:8000"><code>localhost:8000</code></a>.</li>
19391939
</ol>
19401940
<h3 id="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-
<div class="highlight"><pre><span></span><code># locally, on master branch (which has your updated docs)
1943-
COMMIT_MSG=&quot;your commit message to replace&quot; 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>
19461942

19471943
</article>
19481944
</div>

dev/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)