From e409115b254822dcb9ab8f12c3ff82649990f241 Mon Sep 17 00:00:00 2001 From: Tiago Ilieve Date: Tue, 28 Apr 2015 01:21:07 -0300 Subject: [PATCH] Docs: fix wrongfully escaped terms --- bootstrapvz/plugins/admin_user/README.rst | 2 +- bootstrapvz/plugins/apt_proxy/README.rst | 10 +++++----- bootstrapvz/plugins/cloud_init/README.rst | 6 +++--- bootstrapvz/plugins/docker_daemon/README.rst | 2 +- bootstrapvz/plugins/image_commands/README.rst | 4 ++-- bootstrapvz/plugins/minimize_size/README.rst | 4 ++-- bootstrapvz/plugins/ntp/README.rst | 2 +- bootstrapvz/plugins/puppet/README.rst | 6 +++--- bootstrapvz/plugins/root_password/README.rst | 2 +- bootstrapvz/plugins/salt/README.rst | 8 ++++---- .../plugins/unattended_upgrades/README.rst | 6 +++--- bootstrapvz/providers/ec2/README.rst | 20 +++++++++---------- 12 files changed, 36 insertions(+), 36 deletions(-) diff --git a/bootstrapvz/plugins/admin_user/README.rst b/bootstrapvz/plugins/admin_user/README.rst index 3506f92..8da68d1 100644 --- a/bootstrapvz/plugins/admin_user/README.rst +++ b/bootstrapvz/plugins/admin_user/README.rst @@ -9,4 +9,4 @@ username specified. Settings ~~~~~~~~ -- ``username``: The username of the account to create. *``required``* +- ``username``: The username of the account to create. ``required`` diff --git a/bootstrapvz/plugins/apt_proxy/README.rst b/bootstrapvz/plugins/apt_proxy/README.rst index 6bc1e83..7e42c3e 100644 --- a/bootstrapvz/plugins/apt_proxy/README.rst +++ b/bootstrapvz/plugins/apt_proxy/README.rst @@ -11,17 +11,17 @@ Settings ~~~~~~~~ - ``address``: The IP or host of the proxy server. - *``required``* + ``required`` - ``port``: The port (integer) of the proxy server. - *``required``* + ``required`` - ``username``: The username for authentication against the proxy server. This is ignored if ``password`` is not also set. - *``optional``* + ``optional`` - ``password``: The password for authentication against the proxy server. This is ignored if ``username`` is not also set. - *``optional``* + ``optional`` - ``persistent``: Whether the proxy configuration file should remain on the machine or not. Valid values: true, false Default: ``false`` - *``optional``* + ``optional`` diff --git a/bootstrapvz/plugins/cloud_init/README.rst b/bootstrapvz/plugins/cloud_init/README.rst index fa36e1f..b5dc6c8 100644 --- a/bootstrapvz/plugins/cloud_init/README.rst +++ b/bootstrapvz/plugins/cloud_init/README.rst @@ -12,12 +12,12 @@ Settings ~~~~~~~~ - ``username``: The username of the account to create. - *``required``* + ``required`` - ``disable_modules``: A list of strings specifying which cloud-init modules should be disabled. - *``optional``* + ``optional`` - ``metadata_sources``: A string that sets the `datasources `__ that cloud-init should try fetching metadata from. The source is automatically set when using the ec2 provider. - *``optional``* + ``optional`` diff --git a/bootstrapvz/plugins/docker_daemon/README.rst b/bootstrapvz/plugins/docker_daemon/README.rst index e210435..c559ab1 100644 --- a/bootstrapvz/plugins/docker_daemon/README.rst +++ b/bootstrapvz/plugins/docker_daemon/README.rst @@ -15,4 +15,4 @@ Settings - ``version``: Selects the docker version to install. To select the latest version simply omit this setting. Default: ``latest`` - *``optional``* + ``optional`` diff --git a/bootstrapvz/plugins/image_commands/README.rst b/bootstrapvz/plugins/image_commands/README.rst index 106ad22..5ed7e65 100644 --- a/bootstrapvz/plugins/image_commands/README.rst +++ b/bootstrapvz/plugins/image_commands/README.rst @@ -15,5 +15,5 @@ Settings (to circumvent this, simply put the entire command in a single string). In addition to the manifest variables ``{root}`` is also available. It points at the root of the image volume. - *``required``* - *``manifest vars``* + ``required`` + ``manifest vars`` diff --git a/bootstrapvz/plugins/minimize_size/README.rst b/bootstrapvz/plugins/minimize_size/README.rst index e275237..bb7860c 100644 --- a/bootstrapvz/plugins/minimize_size/README.rst +++ b/bootstrapvz/plugins/minimize_size/README.rst @@ -29,9 +29,9 @@ Settings zeroes, so the volume could be better shrunk after this. Valid values: true, false Default: false - *``optional``* + ``optional`` - ``shrink``: Whether the volume should be shrunk. This setting works best in conjunction with the zerofree tool. Valid values: true, false Default: false - *``optional``* + ``optional`` diff --git a/bootstrapvz/plugins/ntp/README.rst b/bootstrapvz/plugins/ntp/README.rst index 40421b1..f90c81a 100644 --- a/bootstrapvz/plugins/ntp/README.rst +++ b/bootstrapvz/plugins/ntp/README.rst @@ -9,4 +9,4 @@ Settings - ``servers``: A list of strings specifying which servers should be used to synchronize the machine clock. - *``optional``* + ``optional`` diff --git a/bootstrapvz/plugins/puppet/README.rst b/bootstrapvz/plugins/puppet/README.rst index 203e0b3..530694f 100644 --- a/bootstrapvz/plugins/puppet/README.rst +++ b/bootstrapvz/plugins/puppet/README.rst @@ -16,9 +16,9 @@ Settings ~~~~~~~~ - ``manifest``: Path to the puppet manifest that should be applied. - *``optional``* + ``optional`` - ``assets``: Path to puppet assets. The contents will be copied into ``/etc/puppet`` on the image. Any existing files will be overwritten. - *``optional``* + ``optional`` - ``enable_agent``: Whether the puppet agent daemon should be enabled. - *``optional``* + ``optional`` diff --git a/bootstrapvz/plugins/root_password/README.rst b/bootstrapvz/plugins/root_password/README.rst index a24d904..c2f37c8 100644 --- a/bootstrapvz/plugins/root_password/README.rst +++ b/bootstrapvz/plugins/root_password/README.rst @@ -8,4 +8,4 @@ Settings ~~~~~~~~ - ``password``: The password for the root user. - *``required``* + ``required`` diff --git a/bootstrapvz/plugins/salt/README.rst b/bootstrapvz/plugins/salt/README.rst index acb71ab..cb48c4b 100644 --- a/bootstrapvz/plugins/salt/README.rst +++ b/bootstrapvz/plugins/salt/README.rst @@ -11,16 +11,16 @@ Settings - ``install_source``: Source to install salt codebase from. ``stable`` for current stable, ``daily`` for installing the daily build, and ``git`` to install from git repository. - *``required``* + ``required`` - ``version``: Only needed if you are installing from ``git``. \ ``develop`` to install current development head, or provide any tag name or commit hash from `salt repo `__ - *``optional``* + ``optional`` - ``master``: Salt master FQDN or IP - *``optional``* + ``optional`` - ``grains``: Set `salt grains `__ for this minion. Accepts a map with grain name as key and the grain data as value. - *``optional``* + ``optional`` diff --git a/bootstrapvz/plugins/unattended_upgrades/README.rst b/bootstrapvz/plugins/unattended_upgrades/README.rst index 3339b7b..7caded2 100644 --- a/bootstrapvz/plugins/unattended_upgrades/README.rst +++ b/bootstrapvz/plugins/unattended_upgrades/README.rst @@ -10,9 +10,9 @@ Settings ~~~~~~~~ - ``update_interval``: Days between running ``apt-get update``. - *``required``* + ``required`` - ``download_interval``: Days between running ``apt-get upgrade --download-only`` - *``required``* + ``required`` - ``upgrade_interval``: Days between installing any security upgrades. - *``required``* + ``required`` diff --git a/bootstrapvz/providers/ec2/README.rst b/bootstrapvz/providers/ec2/README.rst index c968f48..184f236 100644 --- a/bootstrapvz/providers/ec2/README.rst +++ b/bootstrapvz/providers/ec2/README.rst @@ -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 under the ``provider`` section. -- **``access-key``**: AWS access-key. +- ``access-key``: AWS access-key. May also be supplied via the environment variable ``$AWS_ACCESS_KEY`` - *``required for EBS & S3 backing``* -- **``secret-key``**: AWS secret-key. + ``required for EBS & S3 backing`` +- ``secret-key``: AWS secret-key. May also be supplied via the environment variable ``$AWS_SECRET_KEY`` - *``required for EBS & S3 backing``* -- **``certificate``**: Path to the AWS user certificate. Used for + ``required for EBS & S3 backing`` +- ``certificate``: Path to the AWS user certificate. Used for uploading the image to an S3 bucket. May also be supplied via the environment variable ``$AWS_CERTIFICATE`` - *``required for S3 backing``* -- **``private-key``**: Path to the AWS private key. Used for uploading + ``required for S3 backing`` +- ``private-key``: Path to the AWS private key. Used for uploading the image to an S3 bucket. May also be supplied via the environment variable ``$AWS_PRIVATE_KEY`` - *``required for S3 backing``* -- **``user-id``**: AWS user ID. Used for uploading the image to an S3 + ``required for S3 backing`` +- ``user-id``: AWS user ID. Used for uploading the image to an S3 bucket. May also be supplied via the environment variable ``$AWS_USER_ID`` - *``required for S3 backing``* + ``required for S3 backing`` Example: