Skip to content

Commit 235c2a4

Browse files
authored
Fix readme (#563)
1 parent 4e8fc4b commit 235c2a4

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.rst

+10-8
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ AWS. However, writing CloudFormation templates in JSON format is not
4545
human-friendly, which hinders developer productivity. Also, many parts
4646
of a CloudFormation template are reusable among applications of the
4747
same kind and CloudFormation does not provide a way to reuse
48-
templates.
48+
templates.
4949

5050
Senza addresses these problems by supporting CloudFormation
5151
templates as YAML input and adding its own 'components' on
@@ -133,7 +133,7 @@ applications and versions:
133133
134134
$ senza list
135135
$ senza l
136-
136+
137137
138138
Routing Traffic
139139
---------------
@@ -164,15 +164,15 @@ To delete stacks that you're no longer using:
164164
Bash Completion
165165
---------------
166166

167-
Bash's programmable completion feature permits typing a partial command, then pressing the :kbd:`[Tab]` key to autocomplete the command sequence. If multiple completions are possible, then :kbd:`[Tab]` lists them all.
167+
Bash's programmable completion feature permits typing a partial command, then pressing the ``[Tab]`` key to autocomplete the command sequence. If multiple completions are possible, then ``[Tab]`` lists them all.
168168

169169
To activate bash completion for the Senza CLI, just run:
170170

171171
.. code-block:: bash
172172
173173
$ eval "$(_SENZA_COMPLETE=source senza)"
174174
175-
Put the eval line into your :file:`.bashrc`:
175+
Put the eval line into your ``.bashrc``:
176176

177177
.. code-block:: bash
178178
@@ -193,6 +193,7 @@ The Senza CLI supports three different output formats:
193193

194194
JSON is best for handling the output programmatically via various languages or with `jq`_ (a command-line JSON processor). The text format is easy for humans to read, and "tsv" format works well with traditional Unix text processing tools like sed, grep, and awk:
195195

196+
.. _jq: https://stedolan.github.io/jq/
196197
.. _tab-separated values (TSV): https://en.wikipedia.org/wiki/Tab-separated_values
197198
.. code-block:: bash
198199
@@ -218,7 +219,7 @@ A minimal Senza definition without any Senza components would look like:
218219
**Tip**: Use ``senza init`` to quickly bootstrap a new Senza definition YAML for most common use cases (e.g. a web application).
219220

220221
The SenzaInfo Key
221-
----------------
222+
-----------------
222223

223224
The ``SenzaInfo`` key configures global Senza behavior and must always be present in the definition YAML. Available properties for the ``SenzaInfo`` section:
224225

@@ -228,7 +229,7 @@ The ``SenzaInfo`` key configures global Senza behavior and must always be presen
228229
Optional SNS topic name or ARN for CloudFormation notifications. As an example: You can use this to send notifications about deployments to a mailing list.
229230
``Parameters``
230231
Custom Senza definition parameters. Use to dynamically substitute variables in the CloudFormation template.
231-
232+
232233
.. code-block:: yaml
233234
234235
# basic information for generating and executing this definition
@@ -286,6 +287,7 @@ You can also specify the parameters by name, which makes the Senza CLI more read
286287
complex scenarios with sizeable number of parameters:
287288

288289
.. code-block:: bash
290+
289291
$ senza create example.yaml 3 example MintBucket=<mint-bucket> ImageVersion=latest
290292
291293
Here, the ``ApplicationId`` is given as a positional parameter. The two
@@ -356,7 +358,7 @@ Senza templates offer the following properties:
356358
Mappings
357359
================
358360

359-
Senza mappings are essentially key-value pairs, and behave just like `CloudFormation mappings <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html>`_. Use mappings for ``Images``, ``ServerSubnets`` or ``LoadBalancerSubnets``.
361+
Senza mappings are essentially key-value pairs, and behave just like `CloudFormation mappings <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html>`_. Use mappings for ``Images``, ``ServerSubnets`` or ``LoadBalancerSubnets``.
360362

361363
An example:
362364

@@ -426,7 +428,7 @@ WeightedDnsElasticLoadBalancer
426428
================================
427429

428430
Senza's **WeightedDnsElasticLoadBalancer** component type creates one HTTPs ELB resource with Route 53 weighted domains.
429-
You can either auto-detect the SSL certificate name used by the ELB, or name it ``SSLCertificateId``. Specify the main domain (``MainDomain``) or the default Route53 hosted zone will apply.
431+
You can either auto-detect the SSL certificate name used by the ELB, or name it ``SSLCertificateId``. Specify the main domain (``MainDomain``) or the default Route53 hosted zone will apply.
430432

431433
An internal load balancer is created by default, which differs from AWS's default behavior. To create an Internet-facing ELB, explicitly set the ``Scheme`` to ``internet-facing``.
432434

0 commit comments

Comments
 (0)