Commit 039d640a authored by Daniel Dehennin's avatar Daniel Dehennin

Merge branch 'doc/complete-readme' into 'master'

docs(readme): improve formula documentation

See merge request la-crise/discourse-formula!15
parents 8df524f8 1947c947
......@@ -81,16 +81,33 @@ It depends on ``discourse.sources.hack``.
*Meta-state (This is a state that includes other states)*.
This state will rebuild the ``discourse`` application container if the
``discourse.config`` has changes.
This state will rebuild the ``discourse`` application container if any
configuration file has changed and make sure the container is started.
``discourse.service.rebuild``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will rebuild the ``discourse`` application container if any
configuration file has changed.
It depends on:
- ``discourse.sources.hack``
- ``discourse.config.file``
``discourse.service.running``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This state will start the application container if it's not running.
It depends on ``discourse.service.rebuild``.
``discourse.setup``
^^^^^^^^^^^^^^^^^^^
*Meta-state (This is a state that includes other states)*.
This state will initialize the ``discourse`` application with sane
defaults.
This state will initialise some ``discourse`` application parameters.
``discourse.setup.settings``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
......@@ -122,12 +139,20 @@ It depends on ``discourse.service.running``.
``discourse.setup.users``
^^^^^^^^^^^^^^^^^^^^^^^^^
This state will manage a set of users:
*Meta-state (This is a state that includes other states)*.
This state will manage a set of users based on salt configuration.
``discourse.setup.users.create``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- create them if they don't exists
- send password reset email by default or set their password if defined
- set them active or not
- set them ``admin`` or not.
This state will manage a set of users based on salt configuration:
- create them if they don't exists and send password reset email
- set them active or disable them
- set them ``admin`` if configured
It depends on ``discourse.service.running``.
``discourse.setup.themes``
^^^^^^^^^^^^^^^^^^^^^^^^^^
......@@ -290,5 +315,8 @@ Install the ``netcat`` package required by the deployment of ``discourse``.
Install the ``net-tools`` package required by the deployment of ``discourse``.
.. _pillar.example: ../pillar.example
.. _discourse: https://www.discourse.org
.. _discourse_docker: https://github.com/discourse/discourse_docker
.. _site settings: https://github.com/discourse/discourse/blob/master/config/site_settings.yml
.. _OAuth2 plugin settings: https://github.com/discourse/discourse-oauth2-basic/blob/master/config/settings.yml
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment