hendrik/lens
1
0 Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Deployed 532b10e3 to latest with MkDocs 1.1.2 and mike 0.5.5

Browse Source
This commit is contained in:
GitHub Action committed 2020-11-17 06:51:18 +00:00
1 parent 72a2a5b025
commit 5e7c739bd6
200 files changed
+3396 -3395
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

latest/contributing/documentation/index.html
+5 -5
View File
@@ -829,13 +829,13 @@
<h1 id="documentation">Documentation<a class="headerlink" href="#documentation" title="Permanent link">#</a></h1>
<p>We are glad to see you are interested in contributing to Lens documentation. If this is the first Open Source project you will contribute to, we strongly suggest reading GitHub's excellent guide: <a href="https://opensource.guide/how-to-contribute">How to Contribute to Open Source</a>.</p>
<p>We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: <a href="https://opensource.guide/how-to-contribute">How to Contribute to Open Source</a>.</p>
<h2 id="finding-documentation-issues-to-work-on">Finding Documentation Issues to Work On<a class="headerlink" href="#finding-documentation-issues-to-work-on" title="Permanent link">#</a></h2>
<p>You can find a list of open documentation related issues <a href="https://github.com/lensapp/lens/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fdocumentation">here</a>. When you find something you would like to work on:</p>
<p>You can find a list of open documentation-related issues <a href="https://github.com/lensapp/lens/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fdocumentation">here</a>. When you find something you would like to work on:</p>
<ol>
<li>Express your interest to start working on an issue via comments.</li>
<li>One of the maintainers will assign the issue for you.</li>
<li>You can start working on the issue. Once done, simply submit a pull request.</li>
<li>You can start working on the issue. When you're done, simply submit a pull request.</li>
</ol>
<h2 id="requirements-for-documentation-pull-requests">Requirements for Documentation Pull Requests<a class="headerlink" href="#requirements-for-documentation-pull-requests" title="Permanent link">#</a></h2>
<p>When you create a new pull request, we expect some requirements to be met.</p>
@@ -844,8 +844,8 @@
<li>When adding new documentation, add <code>New Documentation:</code> before the title. E.g. <code>New Documentation: Getting Started</code></li>
<li>When fixing documentation, add <code>Fix Documentation:</code> before the title. E.g. <code>Fix Documentation: Getting Started</code></li>
<li>When updating documentation, add <code>Update Documentation:</code> before the title. E.g. <code>Update Documentation: Getting Started</code></li>
<li>If your Pull Request closes an issue you need to write <code>Closes #ISSUE_NUMBER</code> where the ISSUE_NUMBER is the number in the end of the link url that will link your pull request to the issue, when merged will close that issue.</li>
<li>For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid and the linter is passing.</li>
<li>If your Pull Request closes an issue, you must write <code>Closes #ISSUE_NUMBER</code> where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close.</li>
<li>For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.</li>
</ul>