saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Reorganized and reworded the contents page for better focus

Browse source 
Also moved the TOC to its own doc to provide a complete and
comprehensive overview. Removed some extra and unecessary toctree calls.
This commit is contained in:
Seth House 2011-10-30 10:11:09 -06:00
parent 280c5ec4eb
commit a912520cf8
12 changed files with 90 additions and 131 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

124
doc/contents.rst
View file

@ -1,103 +1,67 @@
.. _contents:
Tutorials
=========
Salt at a glance
================
Introduce yourself to the various parts of Salt in five minute increments.
Learn about the various parts of Salt in five minute increments (or less).
.. toctree::
:maxdepth: 1
* **What is Salt?:**
:doc:`Overview <topics/index>`
| :doc:`Community </topics/community>`
* **The basics:**
:doc:`Installation <topics/installation>`
| :doc:`Configuration <topics/configuration>`
* **Remote execution:**
:doc:`Modules <topics/tutorials/modules>`
* **State management:**
:doc:`Part 1 <topics/tutorials/states_pt1>`
| :doc:`Part 2 <topics/tutorials/states_pt2>`
| :doc:`Part 3 <topics/tutorials/states_pt3>`
topics/tutorial
Salt in Depth
Salt in depth
=============
While using and setting up Salt is a simple task, the capabilities of Salt
run much deeper.
While using and setting up Salt is a simple task, the capabilities of Salt run
much deeper. Gaining a better understanding of how Salt works will allow you to
get much more out of Salt.
Gaining a better understanding of how Salt works will allow you to get much
more out of Salt.
Screencasts and Presentations
-----------------------------
Presentation at the Salt Lake Linux User Group (SLLUG) in May 2011
`video`_ | `slides`_ (PDF)
.. _`video`: http://blip.tv/thomas-s-hatch/salt-0-8-7-presentation-5180182
.. _`slides`: :download:`Salt.pdf`
Configuration and CLI Usage
---------------------------
.. toctree::
:maxdepth: 1
ref/configuration/index
ref/cli/index
Extending Salt
==============
Writing your own customizations on top of Salt
.. toctree::
:hidden:
ref/index
ref/modules/index
ref/grains
ref/returners/index
ref/states/index
ref/runners
ref/renderers
ref/python-api
ref/file_server/index
* **Modules:**
* **Remote execution:**
:doc:`Writing modules <ref/modules/index>`
| :doc:`full list of modules <ref/modules/modules>`
* **Grains:**
* **System info & detection:**
:doc:`Grains <ref/grains>`
* **Returners:**
* **Displaying or storing responses:**
:doc:`Writing returners <ref/returners/index>`
| :doc:`full list of returners <ref/returners/returners>`
* **State enforcement:**
:doc:`States <ref/states/index>`
| :doc:`Renderers <ref/renderers>`
* **Python API:**
:doc:`Python API <ref/python-api>`
* **File Server:**
| :doc:`Renderers <ref/renderers/index>`
* **Transfering & syncing files:**
:doc:`File Server <ref/file_server/index>`
* **Network topology:**
:doc:`ref/syndic`
| :doc:`ref/peer`
* **Configuration:**
:doc:`Full list of minion settings <ref/configuration/minion>`
| :doc:`Full list of master settings <ref/configuration/master>`
* **Using Salt:**
:doc:`From the command-line <ref/cli/index>`
| :doc:`Through the Python API <ref/python-api>`
Salt Network Topology
=====================
.. admonition:: Screencasts and presentations
Salt can be extended beyond a simple master commanding minions, for more
information read up on the peer and syndic interfaces.
* Presentation at the Salt Lake Linux User Group (SLLUG) in May 2011
`video`_ | `slides`_ (PDF)
.. toctree::
:maxdepth: 1
.. _`video`: http://blip.tv/thomas-s-hatch/salt-0-8-7-presentation-5180182
.. _`slides`: :download:`Salt.pdf`
ref/syndic
ref/peer
Salt quick reference
====================
Getting Involved
================
There are many ways to interact with the Salt community.
.. toctree::
:maxdepth: 1
topics/community
topics/releases/index
Indices, glossary and tables
============================
* :ref:`genindex`
* :doc:`Release notes </topics/releases/index>`
| :doc:`Roadmap </topics/roadmap/index>`
* :ref:`modindex`
| :ref:`genindex`
| :doc:`Full table of contents </toc>`
* :ref:`search`

10
doc/ref/cli/index.rst
View file

@ -2,16 +2,6 @@
Command Line Reference
======================
.. toctree::
:maxdepth: 1
salt
salt-master
salt-minion
salt-key
salt-cp
salt-call
Salt can be controlled by a command line client by the root user on the Salt
master. The Salt command line client uses the Salt client API to communicate
with the Salt master server. The Salt client is straightforward and simple

5
doc/ref/configuration/master.rst
View file

@ -7,11 +7,6 @@ of the Salt system each have a respective configuration file. The
:command:`salt-master` is configured via the master configuration file, and the
:command:`salt-minion` is configured via the minion configuration file.
.. toctree::
:hidden:
examples
.. seealso::
:ref:`example master configuration file <configuration-examples-master>`

5
doc/ref/configuration/minion.rst
View file

@ -7,11 +7,6 @@ of the Salt system each have a respective configuration file. The
:command:`salt-master` is configured via the master configuration file, and the
:command:`salt-minion` is configured via the minion configuration file.
.. toctree::
:hidden:
examples
.. seealso::
:ref:`example minion configuration file <configuration-examples-minion>`

6
doc/ref/modules/index.rst
View file

@ -4,12 +4,6 @@ Modules
Salt modules are the functions called by the :command:`salt` command.
.. toctree::
:hidden:
:glob:
*
.. seealso:: :doc:`Full list of builtin modules <modules>`
Salt ships with many modules that cover a wide variety of tasks.

0
doc/ref/renderers.rst → doc/ref/renderers/index.rst
View file

1
doc/ref/renderers/renderers.rst
View file

@ -16,4 +16,3 @@ Full list of builtin renderers
.. automodule:: salt.renderers.yaml_mako
:members:

6
doc/ref/returners/index.rst
View file

@ -2,12 +2,6 @@
Returners
=========
.. toctree::
:hidden:
:glob:
*
By default the return values of the commands sent to the salt minions are
returned to the salt-master. But since the commands executed on the salt
minions are detatched from the call on the salt master, there is no need for

40
doc/toc.rst Normal file
View file

@ -0,0 +1,40 @@
======================
Full Table of Contents
======================
.. toctree::
:maxdepth: 3
:glob:
topics/index
topics/installation
topics/configuration
topics/tutorials/modules
topics/tutorials/states*
topics/community
ref/index
ref/modules/*
ref/grains
ref/returners/*
ref/states/*
ref/renderers/*
ref/runners
ref/peer
ref/syndic
ref/python-api
ref/file_server/index
ref/configuration/*
ref/cli/index
ref/cli/salt
ref/cli/salt-master
ref/cli/salt-minion
ref/cli/salt-key
ref/cli/salt-cp
ref/cli/salt-call
ref/cli/salt-run
ref/cli/salt-syndic
topics/roadmap/index
topics/releases/index

8
doc/topics/releases/0.8.9.rst
View file

@ -29,12 +29,8 @@ Here s the md5sum:
7d5aca4633bc22f59045f59e82f43b56
For instructions on how to set up Salt please see the tutorial
.. toctree::
:maxdepth: 1
../tutorial
For instructions on how to set up Salt please see the :doc:`installation
instructions </topics/installation>`.
New Features
------------

8
doc/topics/releases/0.9.0.rst
View file

@ -24,12 +24,8 @@ Here is the md5sum:
9a925da04981e65a0f237f2e77ddab37
For instructions on how to set up Salt please see the tutorial
.. toctree::
:maxdepth: 1
../tutorial
For instructions on how to set up Salt please see the :doc:`installation
instructions </topics/installation>`.
New Features
------------

8
doc/topics/releases/0.9.2.rst
View file

@ -23,12 +23,8 @@ Or from PiPy:
http://pypi.python.org/packages/source/s/salt/salt-0.9.2.tar.gz
For instructions on how to set up Salt please see the tutorial
.. toctree::
:maxdepth: 1
../tutorial
For instructions on how to set up Salt please see the :doc:`installation
instructions </topics/installation>`.
New Features
------------