Docs: fix wrongfully escaped terms

This commit is contained in:
Tiago Ilieve 2015-04-28 01:21:07 -03:00
parent c6087f398d
commit e409115b25
12 changed files with 36 additions and 36 deletions

View file

@ -9,4 +9,4 @@ username specified.
Settings Settings
~~~~~~~~ ~~~~~~~~
- ``username``: The username of the account to create. *``required``* - ``username``: The username of the account to create. ``required``

View file

@ -11,17 +11,17 @@ Settings
~~~~~~~~ ~~~~~~~~
- ``address``: The IP or host of the proxy server. - ``address``: The IP or host of the proxy server.
*``required``* ``required``
- ``port``: The port (integer) of the proxy server. - ``port``: The port (integer) of the proxy server.
*``required``* ``required``
- ``username``: The username for authentication against the proxy server. - ``username``: The username for authentication against the proxy server.
This is ignored if ``password`` is not also set. This is ignored if ``password`` is not also set.
*``optional``* ``optional``
- ``password``: The password for authentication against the proxy server. - ``password``: The password for authentication against the proxy server.
This is ignored if ``username`` is not also set. This is ignored if ``username`` is not also set.
*``optional``* ``optional``
- ``persistent``: Whether the proxy configuration file should remain on - ``persistent``: Whether the proxy configuration file should remain on
the machine or not. the machine or not.
Valid values: true, false Valid values: true, false
Default: ``false`` Default: ``false``
*``optional``* ``optional``

View file

@ -12,12 +12,12 @@ Settings
~~~~~~~~ ~~~~~~~~
- ``username``: The username of the account to create. - ``username``: The username of the account to create.
*``required``* ``required``
- ``disable_modules``: A list of strings specifying which cloud-init - ``disable_modules``: A list of strings specifying which cloud-init
modules should be disabled. modules should be disabled.
*``optional``* ``optional``
- ``metadata_sources``: A string that sets the - ``metadata_sources``: A string that sets the
`datasources <http://cloudinit.readthedocs.org/en/latest/topics/datasources.html>`__ `datasources <http://cloudinit.readthedocs.org/en/latest/topics/datasources.html>`__
that cloud-init should try fetching metadata from. The source is that cloud-init should try fetching metadata from. The source is
automatically set when using the ec2 provider. automatically set when using the ec2 provider.
*``optional``* ``optional``

View file

@ -15,4 +15,4 @@ Settings
- ``version``: Selects the docker version to install. To select the - ``version``: Selects the docker version to install. To select the
latest version simply omit this setting. latest version simply omit this setting.
Default: ``latest`` Default: ``latest``
*``optional``* ``optional``

View file

@ -15,5 +15,5 @@ Settings
(to circumvent this, simply put the entire command in a single (to circumvent this, simply put the entire command in a single
string). In addition to the manifest variables ``{root}`` is also string). In addition to the manifest variables ``{root}`` is also
available. It points at the root of the image volume. available. It points at the root of the image volume.
*``required``* ``required``
*``manifest vars``* ``manifest vars``

View file

@ -29,9 +29,9 @@ Settings
zeroes, so the volume could be better shrunk after this. zeroes, so the volume could be better shrunk after this.
Valid values: true, false Valid values: true, false
Default: false Default: false
*``optional``* ``optional``
- ``shrink``: Whether the volume should be shrunk. This setting works - ``shrink``: Whether the volume should be shrunk. This setting works
best in conjunction with the zerofree tool. best in conjunction with the zerofree tool.
Valid values: true, false Valid values: true, false
Default: false Default: false
*``optional``* ``optional``

View file

@ -9,4 +9,4 @@ Settings
- ``servers``: A list of strings specifying which servers should be - ``servers``: A list of strings specifying which servers should be
used to synchronize the machine clock. used to synchronize the machine clock.
*``optional``* ``optional``

View file

@ -16,9 +16,9 @@ Settings
~~~~~~~~ ~~~~~~~~
- ``manifest``: Path to the puppet manifest that should be applied. - ``manifest``: Path to the puppet manifest that should be applied.
*``optional``* ``optional``
- ``assets``: Path to puppet assets. The contents will be copied into - ``assets``: Path to puppet assets. The contents will be copied into
``/etc/puppet`` on the image. Any existing files will be overwritten. ``/etc/puppet`` on the image. Any existing files will be overwritten.
*``optional``* ``optional``
- ``enable_agent``: Whether the puppet agent daemon should be enabled. - ``enable_agent``: Whether the puppet agent daemon should be enabled.
*``optional``* ``optional``

View file

@ -8,4 +8,4 @@ Settings
~~~~~~~~ ~~~~~~~~
- ``password``: The password for the root user. - ``password``: The password for the root user.
*``required``* ``required``

View file

@ -11,16 +11,16 @@ Settings
- ``install_source``: Source to install salt codebase from. ``stable`` - ``install_source``: Source to install salt codebase from. ``stable``
for current stable, ``daily`` for installing the daily build, and for current stable, ``daily`` for installing the daily build, and
``git`` to install from git repository. ``git`` to install from git repository.
*``required``* ``required``
- ``version``: Only needed if you are installing from ``git``. - ``version``: Only needed if you are installing from ``git``.
\ ``develop`` to install current development head, or provide any tag \ ``develop`` to install current development head, or provide any tag
name or commit hash from `salt name or commit hash from `salt
repo <https://github.com/saltstack/salt>`__ repo <https://github.com/saltstack/salt>`__
*``optional``* ``optional``
- ``master``: Salt master FQDN or IP - ``master``: Salt master FQDN or IP
*``optional``* ``optional``
- ``grains``: Set `salt - ``grains``: Set `salt
grains <http://docs.saltstack.com/en/latest/topics/targeting/grains.html>`__ grains <http://docs.saltstack.com/en/latest/topics/targeting/grains.html>`__
for this minion. Accepts a map with grain name as key and the grain for this minion. Accepts a map with grain name as key and the grain
data as value. data as value.
*``optional``* ``optional``

View file

@ -10,9 +10,9 @@ Settings
~~~~~~~~ ~~~~~~~~
- ``update_interval``: Days between running ``apt-get update``. - ``update_interval``: Days between running ``apt-get update``.
*``required``* ``required``
- ``download_interval``: Days between running - ``download_interval``: Days between running
``apt-get upgrade --download-only`` ``apt-get upgrade --download-only``
*``required``* ``required``
- ``upgrade_interval``: Days between installing any security upgrades. - ``upgrade_interval``: Days between installing any security upgrades.
*``required``* ``required``

View file

@ -24,28 +24,28 @@ and secret key, which are needed for bootstraping EBS backed instances.
The settings describes below should be placed in the ``credentials`` key The settings describes below should be placed in the ``credentials`` key
under the ``provider`` section. under the ``provider`` section.
- **``access-key``**: AWS access-key. - ``access-key``: AWS access-key.
May also be supplied via the environment variable May also be supplied via the environment variable
``$AWS_ACCESS_KEY`` ``$AWS_ACCESS_KEY``
*``required for EBS & S3 backing``* ``required for EBS & S3 backing``
- **``secret-key``**: AWS secret-key. - ``secret-key``: AWS secret-key.
May also be supplied via the environment variable May also be supplied via the environment variable
``$AWS_SECRET_KEY`` ``$AWS_SECRET_KEY``
*``required for EBS & S3 backing``* ``required for EBS & S3 backing``
- **``certificate``**: Path to the AWS user certificate. Used for - ``certificate``: Path to the AWS user certificate. Used for
uploading the image to an S3 bucket. uploading the image to an S3 bucket.
May also be supplied via the environment variable May also be supplied via the environment variable
``$AWS_CERTIFICATE`` ``$AWS_CERTIFICATE``
*``required for S3 backing``* ``required for S3 backing``
- **``private-key``**: Path to the AWS private key. Used for uploading - ``private-key``: Path to the AWS private key. Used for uploading
the image to an S3 bucket. the image to an S3 bucket.
May also be supplied via the environment variable May also be supplied via the environment variable
``$AWS_PRIVATE_KEY`` ``$AWS_PRIVATE_KEY``
*``required for S3 backing``* ``required for S3 backing``
- **``user-id``**: AWS user ID. Used for uploading the image to an S3 - ``user-id``: AWS user ID. Used for uploading the image to an S3
bucket. bucket.
May also be supplied via the environment variable ``$AWS_USER_ID`` May also be supplied via the environment variable ``$AWS_USER_ID``
*``required for S3 backing``* ``required for S3 backing``
Example: Example: