Skip to content

Commit 7f3a681

Browse files
committed
docs(chore): Abbreviate some content
1 parent 0cd7f30 commit 7f3a681

2 files changed

Lines changed: 8 additions & 14 deletions

File tree

docs/deploy/deploy.rst

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,16 @@ As with other deployment tasks, do the :doc:`setup tasks<setup>` before the step
66
1. Run Salt function
77
--------------------
88

9-
To limit the output to changes and failures, add a ``--state-output=changes`` option to the commands below, for example:
10-
11-
.. code-block:: bash
12-
13-
./run.py --state-output=changes 'docs' state.apply
14-
159
Deploy a service
1610
~~~~~~~~~~~~~~~~
1711

1812
Indicate the desired target and use the ``state.apply`` function, for example:
1913

2014
.. code-block:: bash
2115
22-
./run.py 'docs' state.apply
16+
./run.py --state-output=changes 'docs' state.apply
2317
24-
The ``state.apply`` function often completes within one minute. You can ignore this warning: ``DeprecationWarning: encoding is deprecated, Use raw=False instead``.
18+
The ``state.apply`` function often completes within one minute.
2519

2620
.. note::
2721

@@ -33,7 +27,7 @@ The ``state.apply`` function often completes within one minute. You can ignore t
3327

3428
.. code-block:: bash
3529
36-
./run.py 'mytarget-dev' state.apply pillar='{"python_apps":{"myapp":{"git":{"branch":"BRANCH_NAME"}}}}'
30+
./run.py --state-output=changes 'mytarget-dev' state.apply pillar='{"python_apps":{"myapp":{"git":{"branch":"BRANCH_NAME"}}}}'
3731
3832
Deploy part of a service
3933
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -42,13 +36,13 @@ To `run a specific state file <https://docs.saltproject.io/en/latest/ref/modules
4236

4337
.. code-block:: bash
4438
45-
./run.py 'docs' state.sls elasticsearch
39+
./run.py --state-output=changes 'docs' state.sls elasticsearch
4640
4741
To `run a specific SLS ID <https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.state.html#salt.modules.state.sls_id>`__, run, for example:
4842

4943
.. code-block:: bash
5044
51-
./run.py '*' state.sls_id root_authorized_keys core.sshd
45+
./run.py --state-output=changes '*' state.sls_id root_authorized_keys core.sshd
5246
5347
.. note::
5448

@@ -90,6 +84,6 @@ States that always report changes:
9084
3. Manual cleanup
9185
-----------------
9286

93-
If you changed the server name of a virtual host that uses HTTPS, you will need to :ref:`ssl-certificates` for the new server name.
94-
9587
If you :doc:`removed a Salt configuration<../develop/update/delete>`, follow the linked steps to cleanup manually.
88+
89+
If you changed the server name of a virtual host that uses HTTPS, :ref:`ssl-certificates`.

docs/develop/update/apache.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ You can configure `mod_md <https://httpd.apache.org/docs/2.4/mod/mod_md.html>`__
299299
300300
.. _mod_md-test:
301301

302-
To test your configuration, use Let's Encrypt's `staging environment <https://letsencrypt.org/docs/staging-environment/>`__, in order to avoid the `duplicate certificate limit <https://letsencrypt.org/docs/duplicate-certificate-limit/>`__:
302+
To test a configuration, use Let's Encrypt's `staging environment <https://letsencrypt.org/docs/staging-environment/>`__ to avoid the `duplicate certificate limit <https://letsencrypt.org/docs/duplicate-certificate-limit/>`__:
303303

304304
.. code-block:: yaml
305305
:emphasize-lines: 6

0 commit comments

Comments
 (0)