docs: fix formatting of `sops` command examples default tip @
authorConnor Sheehan <sheehan@mozilla.com>
Thu, 13 Jun 2019 13:52:12 -0400
changeset 7069 3be27275aa4ddab8d2092aab51f4d255febb9dbf
parent 7068 b53f77f17586070e9896b7390210e0a8eb08edcb
push id3522
push usercosheehan@mozilla.com
push dateThu, 13 Jun 2019 17:52:22 +0000
treeherderversion-control-tools@3be27275aa4d [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
docs: fix formatting of `sops` command examples The missing `:` causes Sphinx to improperly format the command line examples.
docs/hgmo/ops.rst
--- a/docs/hgmo/ops.rst
+++ b/docs/hgmo/ops.rst
@@ -50,17 +50,17 @@ Secrets can be checked in to version-con
 them with ``sops``. To encrypt/decrypt variables checked in to this repo, you
 will need to:
 
 1. Have your Auth0 email be given permission to access the version-control-tools
    secrets key. Ask about this in #vcs, or file a bug under hg.mozilla.org.
 2. `Install the GCP SDK`_.
 3. `Install sops and go through the GCP setup steps`_.
 
-With `sops` installed, you can encrypt and decrypt files with:
+With `sops` installed, you can encrypt and decrypt files with::
 
     $ sops --decrypt path/to/file/configfile.yaml
     $ sops --encrypt path/to/file/configfile.yaml
 
 After running these commands, only keys in the configuration that are suffixed
 with *"_encrypted"* will have their values encrypted. All other values are left
 as cleartext.