From 45143688658e92d769b70b9b35d812097995bde0 Mon Sep 17 00:00:00 2001 From: Seth House Date: Mon, 6 Feb 2012 15:45:24 -0700 Subject: [PATCH] Removed site homepage; replaced with docs homepage --- doc/_templates/index.html | 83 -------------- doc/_templates/indexsidebar.html | 32 ------ doc/_templates/layout.html | 8 +- doc/conf.py | 28 ++--- doc/contents.rst | 2 - doc/home.rst | 80 ------------- doc/index.rst | 187 +++++++++++++++++++++++++++++++ 7 files changed, 201 insertions(+), 219 deletions(-) delete mode 100644 doc/_templates/index.html delete mode 100644 doc/_templates/indexsidebar.html delete mode 100644 doc/home.rst create mode 100644 doc/index.rst diff --git a/doc/_templates/index.html b/doc/_templates/index.html deleted file mode 100644 index 3e372250ef..0000000000 --- a/doc/_templates/index.html +++ /dev/null @@ -1,83 +0,0 @@ -{% extends "layout.html" %} -{% set title = 'Overview' %} - -{% block body %} -
-

What is Salt?

- -

Salt is a powerful remote execution manager that can be used to - administer servers in a fast and efficient way.

- -

Salt allows commands to be executed across large groups of servers. - This means systems can be easily managed, but data can also be easily - gathered. Quick introspection into running systems becomes a - reality.

- -

Remote execution is usually used to set up a certain state on a - remote system. Salt addresses this problem as well, the salt state - system uses salt state files to define the state a server needs to be - in.

- -

Between the remote execution system, and state management Salt - addresses the backbone of cloud and data center management.

- -

The Salt stack

-
-
Remote execution
-
Remote execution is the core of modern cloud and infrastructure - solutions, and Salt offers the fastest and easiest remote execution - system available today
-
- -
-
Configuration management
-
Salt offers the world simplest, yet most powerful, flexible and - scalable configuration management system
-
- -
-
Highly scalable
-
Easily manage tens or hundreds or even tens of thousands of - nodes with a multi-tiered management infrastructure.
-
- -
-
Highly configurable
-
Receive responses where, how, and when you want.
-
-
- -
-

Documentation

- -
-
Tutorials
-
Get started with each Salt component in five minutes or less
-
- -
-
Documentation
-
Comprehensive and in-depth explanations and reference; -
Offline? - - - PDF - | - - ePUB -
-
- -
-
Contents
-
An exhaustive (and exhausting) overview of all the Salt documentation
-
- -
-
Module index
-
Quickly jump to the reference for individual modules, states, and more
-
- -
- -{% endblock %} diff --git a/doc/_templates/indexsidebar.html b/doc/_templates/indexsidebar.html deleted file mode 100644 index 8457607eac..0000000000 --- a/doc/_templates/indexsidebar.html +++ /dev/null @@ -1,32 +0,0 @@ -

Download

- -{% if version.endswith('pre') %} -

This documentation is for version {{ version }}, which is not released yet.

-

You can download it from the GitHub repository.

-{% else %} -

Current version: {{ version }}

-

Get the Salt tarball from the GitHub downloads page, - or packages are available for some OSes.

-

Read the release announcement.

- {# -

Latest development version docs are also available.

- #} -{% endif %} - -

Recent updates

-

Our IRC channel is now on the popular Freenode network. See you there!

-

The Salt git repository can now be found at the new saltstack GitHub organization. -Read why.

- -

Get help. Get involved.

- -
-

Join the mailing list: -
- -

-
- -

Join us via IRC in the #salt channel via - Freenode's webchat.

-

Search bugs or file one.

diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html index 87ec3add61..94b07878de 100644 --- a/doc/_templates/layout.html +++ b/doc/_templates/layout.html @@ -1,6 +1,6 @@ {% extends "!layout.html" %} -{% block rootrellink %} -
  • Salt home | 
    • -
  • Documentation »
    • -{% endblock %} +{%- block rootrellink %} +
  • « SaltStack.org | 
    • +
  • Documentation home
    • +{%- endblock %} diff --git a/doc/conf.py b/doc/conf.py index 615d3f5116..3d4a3e60d6 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -76,20 +76,15 @@ on_rtd = os.environ.get('READTHEDOCS', None) == 'True' project = u'Salt' copyright = u'2011, Thomas S. Hatch' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. version = __version__ -# The full version, including alpha/beta/rc tags. release = version master_doc = 'contents' templates_path = ['_templates'] exclude_patterns = ['_build'] -extensions = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks', 'sphinx.ext.autosummary'] +extensions = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks', + 'sphinx.ext.autosummary'] modindex_common_prefix = ['salt.'] @@ -122,23 +117,20 @@ html_favicon = 'favicon.ico' html_use_smartypants = False html_additional_pages = { - 'index': 'index.html', '404': '404.html', } -html_default_sidebars = [ - 'localtoc.html', - 'relations.html', - 'sourcelink.html', - 'searchbox.html'] - html_sidebars = { - 'ref/**/all/salt.*': ['autosummarysidebar.html'] + html_default_sidebars, - 'index': ['indexsidebar.html', 'searchbox.html'], + 'ref/**/all/salt.*': [ + 'autosummarysidebar.html', + 'localtoc.html', + 'relations.html', + 'sourcelink.html', + 'searchbox.html', + ], } html_context = { - 'html_default_sidebars': html_default_sidebars, 'github_base': 'https://github.com/saltstack/salt', 'github_issues': 'https://github.com/saltstack/salt/issues', 'github_downloads': 'https://github.com/saltstack/salt/downloads', @@ -158,7 +150,7 @@ latex_documents = [ u'Thomas Hatch', 'manual'), ] -latex_logo = '_static/salt.png' +latex_logo = '_static/salt-vert.png' ### Manpage options diff --git a/doc/contents.rst b/doc/contents.rst index efc4c00a26..fc1dce5fbd 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -6,8 +6,6 @@ Full Table of Contents :maxdepth: 3 :glob: - home - topics/index topics/configuration topics/tutorials/modules diff --git a/doc/home.rst b/doc/home.rst deleted file mode 100644 index b7f764e246..0000000000 --- a/doc/home.rst +++ /dev/null @@ -1,80 +0,0 @@ -.. _contents: - -.. |vid| image:: /_static/film_link.png - -.. _docs-tutorials: - -Salt at a glance -================ - -Learn about the various parts of Salt in five minute increments (or less). - -* **What is Salt?:** - :doc:`Overview ` - | :doc:`Community ` -* **The basics:** - `Installation`_ - | :doc:`Configuration ` - | |vid| `Watch the screencast `_ -* **Remote execution:** - :doc:`Modules ` -* **State management:** - :doc:`Part 1 ` - | :doc:`Part 2 ` - | :doc:`Part 3 ` - - - -.. _docs-reference: - -Salt in depth -============= - -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. - -* **Remote execution:** - :doc:`Writing modules ` - | :doc:`full list of modules ` -* **System info & detection:** - :doc:`Grains ` -* **Displaying or storing responses:** - :doc:`Writing returners ` - | :doc:`full list of returners ` -* **State enforcement:** - :doc:`States ` - | :doc:`Highstate data structure ` - | :doc:`full list of states ` -* **Renderers:** - :doc:`Renderers ` - | :doc:`full list of renderers ` -* **Transferring & syncing files:** - :doc:`File Server ` -* **Network topology:** - :doc:`ref/syndic` - | :doc:`ref/peer` -* **Configuration:** - :doc:`Full list of minion settings ` - | :doc:`Full list of master settings ` -* **Using Salt:** - :doc:`From the command-line ` - | :doc:`Through the Python API ` - -.. admonition:: Screencasts and presentations - - * Thomas S. Hatch was `interviewed on episode 191 of FLOSS Weekly - `_. - * Presentation at the Salt Lake Linux User Group (SLLUG) in May 2011 - `video `_ - | :download:`slides ` (PDF) - -Salt quick reference -==================== - -* :doc:`Release notes ` - | :doc:`Roadmap ` -* :ref:`modindex` - | :ref:`genindex` - | :doc:`Full table of contents ` -* :ref:`search` diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..613b4e2718 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,187 @@ +.. _contents: + +.. |vid| image:: /_static/film_link.png + +Get started with Salt +===================== + +.. sidebar:: Presentations + + A list of `presentations and interviews on Salt`_ (including the FLOSS + Weekly interview). + +.. _`presentations and interviews on Salt`: http://saltstack.org/presentations/ + +Salt is a **remote execution** and **configuration management** tool. + +Salt is designed to be secure using **AES encryption** and **public-key +authentication**; incredibly scaleable using an advanced **ZeroMQ** topology; +fast and efficient using **msgpack**; and extensible using small and simple +**Python** modules. + +Read the :doc:`Salt overview ` for a more thorough description. + +Step 1: Remote execution +------------------------ + +.. sidebar:: |vid| Screencasts + + Watch the `remote execution screencast`__. + +.. __: http://blip.tv/saltstack/salt-installation-configuration-and-remote-execution-5713423 + +The quickest way to see Salt in action is to run a command on a :term:`minion` +host from the :term:`master` host. This is widely known as :term:`remote +execution` — executing commands on remote hosts. + +1. `Installation`_ +2. :doc:`Configure the minion ` +3. :doc:`Run remote commands ` + +Step 2: Configuration management +-------------------------------- + +Now that you have the basics out of the way, learn to use Salt to configure +your servers. This is widely known as :term:`configuration management` — +installing packages, configuring users and services, and much more. + +1. :doc:`Basic config management ` +2. :doc:`Less basic config management ` +3. :doc:`Advanced techniques ` + +Salt in depth +============= + +Setting up and using Salt is a simple task but it's capabilities run much, much +deeper. Gaining a better understanding of how Salt works will allow you to +truly make it work for you. + +.. contents:: Overview + :local: + :depth: 2 + +**Remote execution** + Remote execution is the core functionality of Salt. Running pre-defined or + arbitrary commands on remote hosts. + + **Modules** + Salt modules are the core of remote execution. They provide + functionality such as installing a package, restarting a service, + running a remote command, transferring a file — and the list goes on. + + :doc:`Full list of modules ` + The giant list of core modules that ship with Salt + (And there are even more in the `salt-contrib`_ repository!) + + :doc:`Writing modules ` + A guide on how to write Salt modules + + **Targeting** + Specify which hosts should run commands or manage configuration. + + :doc:`Targeting ` + Hostnames, lists, regular expressions, or define groups. + + :doc:`Grains ` + Bits of static information about a minion such as OS, version, + virtualization, CPU, memory, and much more. + + **Returners** + Salt returners allow saving minion responses in various datastores or + to various locations in addition to display at the CLI. + + :doc:`Full list of returners ` + Store minion responses in Redis, Mongo, Cassandra or more. + + :doc:`Writing returners ` + If we're missing your favorite storage backend, webservice, or you + need a custom endpoint returners are *tiny* and simple to write. + +**Configuration management** + Building on the remote execution core is a robust and flexible config + management framework. Execution happens on the minions allowing + effortless, simultaneous configuration of thousands of hosts. + + **States** + Express the state of a host using small, easy to read, easy to + understand configuration files. No programming required (unless you + want to). + + :doc:`Full list of states ` + Install packages, create users, transfer files, start services, and + more and more. + + :doc:`Using states ` + You've seen the big list of available states, now learn how to call + them. + + :doc:`Highstate data structure ` + A dry, vocabulary and technical representation of the configuration + format that states represent. + + **Renderers** + Write state configuration files in the language, templating engine, or + file type of your choice. The world doesn't need yet another DSL. + + :doc:`Full list of renderers ` + YAML? JSON? Jinja? Mako? Python? We got you covered. (And if we + don't, new renderers are *tiny* and easy to write.) + + :doc:`Renderers ` + Salt states are only concerned with the ultimate highstate data + structure. How you create that data structure isn't our business. + Tweak a config option and use whatever you're most comfortable + with. + +**Miscellaneous topics** + Salt is a many splendid thing. + + :doc:`File Server ` + Salt can easily and quickly transfer files (in fact, that's how Salt + States work). Even under load, files are chunked and served. + + :doc:`Syndic ` + A seamless master of masters. Scale Salt to thousands of hosts or + across many different networks. + + :doc:`Peer communication ` + Allow minions to communicate amongst themselves. For example, configure + one minion by querying live data from all the others. With great power + comes great responsibility. + + :doc:`Network topology ` + At it's core, Salt is a highly scalable communication layer built on + top of ZeroMQ that enables remote execution and configuration + management. The possibilities are endless and Salt's future looks + bright. + + :doc:`Python API interface ` + Use Salt programmatically from your own scripts and programs easily and + simply via ``import salt``. + +**Reference** + :doc:`Command-line interface ` + Read the Salt manpages. + + :doc:`Full list of master settings ` + Read through the heavily-commented master configuration file. + + :doc:`Full list of minion settings ` + Read through the heavily-commented minion configuration file. + + :doc:`Full table of contents ` + Dense but complete. + +**More information about the project** + + :doc:`Roadmap ` + Where we're headed. + + :doc:`Release notes ` + Where we've been. + + :doc:`Community ` + How you can get involved. + +.. _`salt-contrib`: https://github.com/saltstack/salt-contrib +.. _`salt-states`: https://github.com/saltstack/salt-states