<p>Philipp Deppenwiese has uploaded this change for <strong>review</strong>.</p><p><a href="https://review.coreboot.org/26262">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Documentation: Update index.md for more structure.<br><br>* Introduce more information about the<br> documentation process in general.<br>* Move getting started and lessons<br> into sub-directories.<br><br>Change-Id: I78c3ec0e8bcc342686277ae141a88d0486680978<br>Signed-off-by: Philipp Deppenwiese <zaolin@das-labor.org><br>---<br>R Documentation/getting_started/build_system.md<br>R Documentation/getting_started/gerrit_guidelines.md<br>A Documentation/getting_started/index.md<br>R Documentation/getting_started/kconfig.md<br>R Documentation/getting_started/submodules.md<br>M Documentation/index.md<br>A Documentation/lessons/index.md<br>R Documentation/lessons/lesson2.md<br>8 files changed, 59 insertions(+), 14 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://review.coreboot.org:29418/coreboot refs/changes/62/26262/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/Documentation/build_system.md b/Documentation/getting_started/build_system.md</span><br><span>similarity index 100%</span><br><span>rename from Documentation/build_system.md</span><br><span>rename to Documentation/getting_started/build_system.md</span><br><span>diff --git a/Documentation/gerrit_guidelines.md b/Documentation/getting_started/gerrit_guidelines.md</span><br><span>similarity index 100%</span><br><span>rename from Documentation/gerrit_guidelines.md</span><br><span>rename to Documentation/getting_started/gerrit_guidelines.md</span><br><span>diff --git a/Documentation/getting_started/index.md b/Documentation/getting_started/index.md</span><br><span>new file mode 100644</span><br><span>index 0000000..b23e89d</span><br><span>--- /dev/null</span><br><span>+++ b/Documentation/getting_started/index.md</span><br><span>@@ -0,0 +1,6 @@</span><br><span style="color: hsl(120, 100%, 40%);">+# Getting Started</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+* [Build System](build_system.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Submodules](submodules.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Kconfig](kconfig.md)</span><br><span style="color: hsl(120, 100%, 40%);">+* [Gerrit Guidelines](gerrit_guidelines.md)</span><br><span>diff --git a/Documentation/core/Kconfig.md b/Documentation/getting_started/kconfig.md</span><br><span>similarity index 100%</span><br><span>rename from Documentation/core/Kconfig.md</span><br><span>rename to Documentation/getting_started/kconfig.md</span><br><span>diff --git a/Documentation/submodules.md b/Documentation/getting_started/submodules.md</span><br><span>similarity index 100%</span><br><span>rename from Documentation/submodules.md</span><br><span>rename to Documentation/getting_started/submodules.md</span><br><span>diff --git a/Documentation/index.md b/Documentation/index.md</span><br><span>index 8354786..8e9e6bf 100644</span><br><span>--- a/Documentation/index.md</span><br><span>+++ b/Documentation/index.md</span><br><span>@@ -1,21 +1,57 @@</span><br><span style="color: hsl(0, 100%, 40%);">-Welcome to coreboot's documentation!</span><br><span style="color: hsl(0, 100%, 40%);">-====================================</span><br><span style="color: hsl(120, 100%, 40%);">+# Welcome to the coreboot documentation</span><br><span> </span><br><span> This is the developer documentation for [coreboot](https://coreboot.org).</span><br><span> It is built from Markdown files in the</span><br><span> [Documentation](https://review.coreboot.org/cgit/coreboot.git/tree/Documentation)</span><br><span> directory in the source code.</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-Contents:</span><br><span style="color: hsl(120, 100%, 40%);">+## How to write documentation</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-* [Lesson 2: Submitting a patch to coreboot.org](Lesson2.md)</span><br><span style="color: hsl(0, 100%, 40%);">-* [Gerrit Etiquette and Guidelines](gerrit_guidelines.md)</span><br><span style="color: hsl(0, 100%, 40%);">-* [coreboot's build system](build_system.md)</span><br><span style="color: hsl(0, 100%, 40%);">-* [Kconfig in coreboot](core/Kconfig.md)</span><br><span style="color: hsl(0, 100%, 40%);">-* [Use of git submodules in coreboot](submodules.md)</span><br><span style="color: hsl(0, 100%, 40%);">-* [Timestamps](timestamp.md)</span><br><span style="color: hsl(0, 100%, 40%);">-* [Dealing with Untrusted Input in SMM](technotes/2017-02-dealing-with-untrusted-input-in-smm.md)</span><br><span style="color: hsl(0, 100%, 40%);">-* [ABI data consumption](abi-data-consumption.md)</span><br><span style="color: hsl(0, 100%, 40%);">-* [GPIO toggling in ACPI AML](acpi/gpio.md)</span><br><span style="color: hsl(0, 100%, 40%);">-* [Native Graphics Initialization with libgfxinit](gfx/libgfxinit.md)</span><br><span style="color: hsl(0, 100%, 40%);">-* [Sandy Bridge Raminit](Intel/NativeRaminit/Sandybridge.md)</span><br><span style="color: hsl(120, 100%, 40%);">+> Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+That said please always try to write documentation! One problem in the firmware development is the missing documentation. In this document you will get a brief introduction how to write, submit and publish documenation to coreboot.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+## Preparations</span><br><span style="color: hsl(120, 100%, 40%);">+coreboot uses [Sphinx](http://www.sphinx-doc.org/en/master/) as documentation tool. We prefer the markdown format over reStructuredText so only embedded ReST is supported. Checkout the [Markdown Guide](https://www.markdownguide.org/)</span><br><span style="color: hsl(120, 100%, 40%);">+for more information</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+### Install Sphinx</span><br><span style="color: hsl(120, 100%, 40%);">+Please follow this official [guide](http://www.sphinx-doc.org/en/stable/install.html).</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+### Optional</span><br><span style="color: hsl(120, 100%, 40%);">+Install [shinx-autobuild](https://github.com/GaretJax/sphinx-autobuild) for rebuilding markdown/rst sources on the fly!</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+## Basic and simple rules</span><br><span style="color: hsl(120, 100%, 40%);">+The following rules must be followed in order to get it at least reviewed on review.coreboot.org.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Documentation:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+1) Must be written in __markdown__ or __embedded reStructuredText__ format.</span><br><span style="color: hsl(120, 100%, 40%);">+2) Must be written in the __English__.</span><br><span style="color: hsl(120, 100%, 40%);">+3) Must be placed into __Documentation/__ directory subfolders which must have the same directory structure as the code under __src/__</span><br><span style="color: hsl(120, 100%, 40%);">+4) Must be linked/included into higher markdown files if sections are used.</span><br><span style="color: hsl(120, 100%, 40%);">+5) Follow the [Gerrit Guidelines](https://doc.coreboot.org/gerrit_guidelines.html).</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+## Markdown and Tables</span><br><span style="color: hsl(120, 100%, 40%);">+Under Sphinx markdown tables are not supported. Therefore you can use following code block to write tables in reStructuredText and embed them into the markdown:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+```eval_rst</span><br><span style="color: hsl(120, 100%, 40%);">++------------+------------+-----------+</span><br><span style="color: hsl(120, 100%, 40%);">+| Header 1 | Header 2 | Header 3 |</span><br><span style="color: hsl(120, 100%, 40%);">++============+============+===========+</span><br><span style="color: hsl(120, 100%, 40%);">+| body row 1 | column 2 | column 3 |</span><br><span style="color: hsl(120, 100%, 40%);">++------------+------------+-----------+</span><br><span style="color: hsl(120, 100%, 40%);">+| body row 2 | Cells may span columns.|</span><br><span style="color: hsl(120, 100%, 40%);">++------------+------------+-----------+</span><br><span style="color: hsl(120, 100%, 40%);">+| body row 3 | Cells may | - Cells |</span><br><span style="color: hsl(120, 100%, 40%);">++------------+ span rows. | - contain |</span><br><span style="color: hsl(120, 100%, 40%);">+| body row 4 | | - blocks. |</span><br><span style="color: hsl(120, 100%, 40%);">++------------+------------+-----------+</span><br><span style="color: hsl(120, 100%, 40%);">+``` #just a code block is enough</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Content:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+1) [Getting Started](getting_started/index.md)</span><br><span style="color: hsl(120, 100%, 40%);">+2) [Rookie Guide](lessons/index.md)</span><br><span>diff --git a/Documentation/lessons/index.md b/Documentation/lessons/index.md</span><br><span>new file mode 100644</span><br><span>index 0000000..94acaa0</span><br><span>--- /dev/null</span><br><span>+++ b/Documentation/lessons/index.md</span><br><span>@@ -0,0 +1,3 @@</span><br><span style="color: hsl(120, 100%, 40%);">+# Rookie Guide</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+* [Lesson 2](lesson2.md)</span><br><span>diff --git a/Documentation/Lesson2.md b/Documentation/lessons/lesson2.md</span><br><span>similarity index 100%</span><br><span>rename from Documentation/Lesson2.md</span><br><span>rename to Documentation/lessons/lesson2.md</span><br><span></span><br></pre><p>To view, visit <a href="https://review.coreboot.org/26262">change 26262</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://review.coreboot.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://review.coreboot.org/26262"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: coreboot </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I78c3ec0e8bcc342686277ae141a88d0486680978 </div>
<div style="display:none"> Gerrit-Change-Number: 26262 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Philipp Deppenwiese <zaolin.daisuki@gmail.com> </div>