Merge pull request #9947 from gyuho/docs-docs

docs: add initial operate guide structure
This commit is contained in:
Gyuho Lee 2018-07-20 15:29:43 -07:00 committed by GitHub
commit e4faaf7e29
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 79 additions and 2 deletions

18
docs/README.md Normal file
View File

@ -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.

View File

@ -2,9 +2,33 @@
etcd Documentation etcd Documentation
================== ==================
* :ref:`faq`: Frequently Asked Questions. This is an official etcd documentation.
* :ref:`client-architecture`: Describes etcd client components.
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:: .. toctree::
:maxdepth: 3 :maxdepth: 3

22
docs/operate.rst Normal file
View File

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

13
docs/set-up.rst Normal file
View File

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