Anastasia Klimchuk has uploaded this change for review.

View Change

doc: Add doc how to add docs

Change-Id: I356a286ad2f3334392efadda366b0ca0f8042752
Signed-off-by: Anastasia Klimchuk <aklm@chromium.org>
---
A doc/how_to_add_docs.rst
M doc/index.rst
2 files changed, 35 insertions(+), 0 deletions(-)

git pull ssh://review.coreboot.org:29418/flashrom refs/changes/25/74225/1

diff --git a/doc/how_to_add_docs.rst b/doc/how_to_add_docs.rst
new file mode 100644
index 0000000..ad5953c
--- /dev/null
+++ b/doc/how_to_add_docs.rst
@@ -0,0 +1,24 @@
+How to add or update docs
+=========================
+
+To add or update a documentation page, you need to create or modify
+an ``.rst`` file in the ``/doc`` directory and send a patch for
+review.
+
+People who are registered in MAINTAINERS file for doc/ directory will
+be automatically added to the patch as reviewers. However, you are
+very welcome to add more reviewers who know the subject. In fact, it
+is always a good idea to add someone who has knowledge of the specific
+area you are documenting.
+
+We are using Sphinx doc engine for documentation (see
+https://www.sphinx-doc.org/) and reStructured Text format for content.
+reStructuredText Primer page has more details
+https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#restructuredtext-primer
+
+Brand new page needs to be added to the appropriate ``index.rst`` file
+under ``/doc`` directory (that could be a root index file or nested one).
+
+To test your changes, build flashrom with documentation and open
+generated ``.html`` file in the browser. Generated ``.html`` files are
+in meson ``builddir/doc/html`` directory.
diff --git a/doc/index.rst b/doc/index.rst
index d309a03..4af7ca4 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -7,5 +7,6 @@
   :hidden:
 
   classic_cli_manpage
+  how_to_add_docs
 
 .. include:: ../README

To view, visit change 74225. To unsubscribe, or for help writing mail filters, visit settings.