aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKonstantin Ryabitsev <konstantin@linuxfoundation.org>2022-09-07 15:46:22 -0400
committerKonstantin Ryabitsev <konstantin@linuxfoundation.org>2022-09-07 15:46:22 -0400
commitee6f2430833afd2cd1e562e98ef66cb343327f0f (patch)
tree7120fbdfda0cb5d242a19721da97637b640fcda6
parentee4d29c39b7fc5f14b23214e84bc6acd4b73a7fb (diff)
downloadb4-ee6f2430833afd2cd1e562e98ef66cb343327f0f.tar.gz
docs: add stubs for subtopics
Mostly, I want to make sure that readthedocs is building things correctly. Actual documentation shortly forthcoming. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
-rw-r--r--docs/conf.py2
-rw-r--r--docs/contributor/overview.rst4
-rw-r--r--docs/contributor/prep.rst4
-rw-r--r--docs/contributor/send.rst4
-rw-r--r--docs/contributor/trailers.rst4
-rw-r--r--docs/getting-support.rst4
-rw-r--r--docs/index.rst41
-rw-r--r--docs/installing.rst4
-rw-r--r--docs/maintainer/keys.rst4
-rw-r--r--docs/maintainer/overview.rst4
-rw-r--r--docs/maintainer/patches.rst4
-rw-r--r--docs/maintainer/prs.rst4
-rw-r--r--docs/maintainer/thanks.rst4
13 files changed, 84 insertions, 3 deletions
diff --git a/docs/conf.py b/docs/conf.py
index d86e5a2..df7c76e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,4 +1,4 @@
-project = 'B4 Enduser Docs'
+project = 'B4 end-user docs'
copyright = '2019-2022, The Linux Foundation and contributors'
author = 'Kernel.org'
templates_path = ['_templates']
diff --git a/docs/contributor/overview.rst b/docs/contributor/overview.rst
new file mode 100644
index 0000000..6253da9
--- /dev/null
+++ b/docs/contributor/overview.rst
@@ -0,0 +1,4 @@
+Contributor overview
+====================
+
+Stub.
diff --git a/docs/contributor/prep.rst b/docs/contributor/prep.rst
new file mode 100644
index 0000000..2d034ef
--- /dev/null
+++ b/docs/contributor/prep.rst
@@ -0,0 +1,4 @@
+Preparing your patch series
+===========================
+
+Stub.
diff --git a/docs/contributor/send.rst b/docs/contributor/send.rst
new file mode 100644
index 0000000..da09547
--- /dev/null
+++ b/docs/contributor/send.rst
@@ -0,0 +1,4 @@
+Sending in your work
+====================
+
+Stub.
diff --git a/docs/contributor/trailers.rst b/docs/contributor/trailers.rst
new file mode 100644
index 0000000..9e36a8f
--- /dev/null
+++ b/docs/contributor/trailers.rst
@@ -0,0 +1,4 @@
+Retrieving code-review trailers
+===============================
+
+Stub.
diff --git a/docs/getting-support.rst b/docs/getting-support.rst
new file mode 100644
index 0000000..5077a15
--- /dev/null
+++ b/docs/getting-support.rst
@@ -0,0 +1,4 @@
+Getting support for b4
+======================
+
+Stub.
diff --git a/docs/index.rst b/docs/index.rst
index 9ed049d..13a796e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,4 +1,41 @@
-B4 enduser documentation
+B4 end-user documentation
+=========================
+
+B4 is a tool created to make it easier for project maintainers to use a
+distributed development workflow that relies on patches and distribution
+lists for code contributions and review.
+
+This documentation is split into two main areas -- one aimed at
+maintainers who primarily receive, review, and apply patches to their
+trees, and the other at developers who submit patches or patch series
+for maintainer review.
+
+For maintainers
+---------------
+.. toctree::
+ :maxdepth: 1
+
+ maintainer/overview
+ maintainer/patches
+ maintainer/prs
+ maintainer/thanks
+ maintainer/keys
+
+For developers
+--------------
+.. toctree::
+ :maxdepth: 1
+
+ contributor/overview
+ contributor/prep
+ contributor/send
+ contributor/trailers
+
+Installation and support
------------------------
+.. toctree::
+ :maxdepth: 1
+
+ installing
+ getting-support
-Stub.
diff --git a/docs/installing.rst b/docs/installing.rst
new file mode 100644
index 0000000..82a8f54
--- /dev/null
+++ b/docs/installing.rst
@@ -0,0 +1,4 @@
+Installing b4
+=============
+
+Stub.
diff --git a/docs/maintainer/keys.rst b/docs/maintainer/keys.rst
new file mode 100644
index 0000000..37a2869
--- /dev/null
+++ b/docs/maintainer/keys.rst
@@ -0,0 +1,4 @@
+Working with contributor keys
+=============================
+
+Stub.
diff --git a/docs/maintainer/overview.rst b/docs/maintainer/overview.rst
new file mode 100644
index 0000000..feaa0ce
--- /dev/null
+++ b/docs/maintainer/overview.rst
@@ -0,0 +1,4 @@
+Maintainer overview
+===================
+
+Stub.
diff --git a/docs/maintainer/patches.rst b/docs/maintainer/patches.rst
new file mode 100644
index 0000000..6f30178
--- /dev/null
+++ b/docs/maintainer/patches.rst
@@ -0,0 +1,4 @@
+Working with patch series
+=========================
+
+Stub.
diff --git a/docs/maintainer/prs.rst b/docs/maintainer/prs.rst
new file mode 100644
index 0000000..0aeccb4
--- /dev/null
+++ b/docs/maintainer/prs.rst
@@ -0,0 +1,4 @@
+Working with pull requests
+==========================
+
+Stub.
diff --git a/docs/maintainer/thanks.rst b/docs/maintainer/thanks.rst
new file mode 100644
index 0000000..cc46933
--- /dev/null
+++ b/docs/maintainer/thanks.rst
@@ -0,0 +1,4 @@
+Sending automated contributor feedback
+======================================
+
+Stub.