Deploy GitHub Pages
This commit is contained in:
parent
2d35024ab8
commit
b6a46bdf86
9 changed files with 14 additions and 14 deletions
|
|
@ -1313,7 +1313,7 @@ See the KEP process for details on each of these items.</p>
|
|||
</ul>
|
||||
<h2 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent link"> ¶</a></h2>
|
||||
<p>The <code>Summary</code> section is incredibly important for producing high quality user-focused documentation such as release notes or a development roadmap.
|
||||
It should be possible to collect this information before implementation begins in order to avoid requiring implementors to split their attention between writing release notes and implementing the feature itself.</p>
|
||||
It should be possible to collect this information before implementation begins in order to avoid requiring implementers to split their attention between writing release notes and implementing the feature itself.</p>
|
||||
<p>A good summary is probably at least a paragraph in length.</p>
|
||||
<h2 id="motivation">Motivation<a class="headerlink" href="#motivation" title="Permanent link"> ¶</a></h2>
|
||||
<p>This section is for explicitly listing the motivation, goals and non-goals of this KEP.
|
||||
|
|
@ -1337,7 +1337,7 @@ The goal here is to make this feel real for users without getting bogged down.</
|
|||
<p>What are the caveats to the implementation?
|
||||
What are some important details that didn't come across above.
|
||||
Go in to as much detail as necessary here.
|
||||
This might be a good place to talk about core concepts and how they releate.</p>
|
||||
This might be a good place to talk about core concepts and how they relate.</p>
|
||||
<h3 id="risks-and-mitigations">Risks and Mitigations<a class="headerlink" href="#risks-and-mitigations" title="Permanent link"> ¶</a></h3>
|
||||
<p>What are the risks of this proposal and how do we mitigate.
|
||||
Think broadly.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue