/site/docs/contribute/ Recent content in Contribute on Open Match Hugo -- gohugo.io /site/docs/contribute/documentation/ Mon, 01 Jan 0001 00:00:00 +0000 /site/docs/contribute/documentation/ <p>Editing the documentation is pretty simple if you are familiar with <a href="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet">Markdown</a>.</p> <h2 id="simple-edits">Simple Edits</h2> <p>If you want to make simple edits to a page (changes that do not require formatting or images) and you&rsquo;re not an approver.</p> <ol> <li>Click the <code>Edit this page</code> link at the top right of the documentation page you want to edit.</li> <li>You&rsquo;ll be redirected to an editor, make your changes there and click <code>Propose file change</code>.</li> <li>Your changes will be reviewed, make any adjustments and submit.</li> </ol> <h2 id="advanced-edits">Advanced Edits</h2> <p>If you&rsquo;re adding a new page, changing the landing page, or making substantial changes.</p> <ol> <li>Check out the repository.</li> <li>Create a branch via <code>git checkout -b mychange upstream/master</code>.</li> <li>Run <code>make run-site</code> to start the webserver. It&rsquo;ll be hosted on http://localhost:8080/.</li> <li>Open your favorite editor and navigate to the documentation which is stored at <code>$(REPOSITORY_ROOT)/site/content/en/</code>.</li> <li>Make your changes and run <code>git commit -m</code> and <code>git push</code></li> <li>Follow the GitHub Pull Request workflow to submit your changes.</li> </ol> <h2 id="platform">Platform</h2> <p>This site and documentation are built with a combination of Hugo, static site generator, with the Docsy theme for open source documentation.</p> <ul> <li><a href="https://gohugo.io/documentation/">Hugo Documentation</a></li> <li><a href="https://github.com/google/docsy">Docsy Guide</a></li> <li><a href="https://github.com/wjdp/htmltest">Link Checker</a></li> </ul>