From 3494514e465c6c76c45360fb5abd88c107332d93 Mon Sep 17 00:00:00 2001 From: Seth House Date: Mon, 19 May 2014 11:50:15 -0600 Subject: [PATCH] Changed README to emphasize the differences with the "ng" states --- README.rst | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index ccfb51f..0e4c572 100644 --- a/README.rst +++ b/README.rst @@ -51,34 +51,43 @@ Installs nginx via the source files. Installs apache utils, and configures nginx users specified in the pillar. +Next-generation, alternate approach +=================================== + +The following states provide an alternate approach to managing Nginx and Nginx +vhosts, as well as code organization. Please provide feedback by filing issues, +discussing in ``#salt`` in Freenode and the mailing list as normal. + ``nginx.ng`` ------------ -Meta-state for inclusion of all ng states. This is a reimplementation that provides basic support for vhost management. +Meta-state for inclusion of all ng states. -**Note:** nginx.ng requires the merge parameter of salt.modules.pillar.get(), first available in the Helium release. +**Note:** nginx.ng requires the merge parameter of salt.modules.pillar.get(), +first available in the Helium release. ``nginx.ng.install`` -~~~~~~~~~~~~~~~~~~~~ +-------------------- Installs the nginx package. ``nginx.ng.config`` -~~~~~~~~~~~~~~~~~~~ +------------------- Manages the nginx main server configuration file. ``nginx.ng.service`` -~~~~~~~~~~~~~~~~~~~~ +-------------------- Manages the startup and running state of the nginx service. ``nginx.ng.vhosts_config`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------- -Manages virtual host files. This state only manages the content of the files and does not bind them to service calls. +Manages virtual host files. This state only manages the content of the files +and does not bind them to service calls. ``nginx.ng.vhosts`` -~~~~~~~~~~~~~~~~~~~ +------------------- -Manages nginx virtual hosts files and binds them to service calls. \ No newline at end of file +Manages nginx virtual hosts files and binds them to service calls.