Browse Source

Merge pull request #9947 from gyuho/docs-docs

docs: add initial operate guide structure
Gyuho Lee 7 years ago
parent
commit
e4faaf7e29
4 changed files with 79 additions and 2 deletions
  1. 18 0
      docs/README.md
  2. 26 2
      docs/index.rst
  3. 22 0
      docs/operate.rst
  4. 13 0
      docs/set-up.rst

+ 18 - 0
docs/README.md

@@ -0,0 +1,18 @@
+
+#### etcd Documentation
+
+This is an official etcd documentation https://etcd.readthedocs.io/en/latest.
+
+Working in progress...
+
+#### Install and build
+
+```bash
+# https://docs.readthedocs.io/en/latest/getting_started.html
+pip install sphinx sphinx-autobuild
+pip install sphinx_rtd_theme
+
+make html
+```
+
+And open `_build/html/index.html` for preview.

+ 26 - 2
docs/index.rst

@@ -2,9 +2,33 @@
 etcd Documentation
 ==================
 
-* :ref:`faq`: Frequently Asked Questions.
-* :ref:`client-architecture`: Describes etcd client components.
+This is an official etcd documentation.
 
+Still working in progress...
+
+* :ref:`set-up`: setting up an etcd cluster.
+* :ref:`operate`: operating an etcd cluster.
+* :ref:`monitor`: monitoring an etcd cluster.
+* :ref:`faq`: frequently asked questions.
+* :ref:`client-architecture`: describes etcd client components.
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Set up
+
+   set-up
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Operate
+
+   operate
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Monitor
+
+   monitor
 
 .. toctree::
    :maxdepth: 3

+ 22 - 0
docs/operate.rst

@@ -0,0 +1,22 @@
+.. _operate:
+
+
+Operate
+#######
+
+TODO
+
+
+Introduction
+============
+
+TODO
+
+
+.. _monitor:
+
+
+Monitor
+#######
+
+TODO

+ 13 - 0
docs/set-up.rst

@@ -0,0 +1,13 @@
+.. _set-up:
+
+
+Set up
+######
+
+TODO
+
+
+Introduction
+============
+
+TODO