Skip to content

Commit 735b941

Browse files
Improve formulations.
Co-authored-by: Andrew Block <[email protected]> Signed-off-by: Felix Fontein <[email protected]>
1 parent 2420d35 commit 735b941

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1700,15 +1700,15 @@ The following top-level keys are supported:
17001700
* ``destination_rules``: a list of destination rule objects.
17011701
* ``stores``: configuration object for the stores.
17021702
1703-
See the next subsections for how these objects look like.
1703+
The following subsections describe how these properties are used.
17041704
17051705
Creation rule object
17061706
~~~~~~~~~~~~~~~~~~~~
17071707
1708-
A creation rule object has three kind of keys:
1708+
A creation rule object has three types of keys:
17091709
1710-
#. Keys that determine whether the creation rule matches;
1711-
#. Keys that determine the (groups of) identities (keys) to encrypt with;
1710+
#. Keys that determine whether the creation rule matches.
1711+
#. Keys that determine the (groups of) identities (keys) to encrypt with.
17121712
#. Keys that determine which parts of and how a file is encrypted.
17131713
17141714
Matching
@@ -1790,7 +1790,7 @@ To directly specify a single key group, you can use the following keys:
17901790
To specify a list of key groups, you can use the following key:
17911791
17921792
* ``key_groups`` (list of key group objects): a list of key group objects.
1793-
See below for how such an object looks like.
1793+
See below for how such a resource should be represented.
17941794
Example:
17951795
17961796
.. code:: yaml
@@ -1829,8 +1829,8 @@ Key group object
18291829
++++++++++++++++
18301830
18311831
A key group contains multiple identities (keys), similar to a creation rule object.
1832-
Having more than one key group allows to use `Shamir's secret sharing <https://en.wikipedia.org/wiki/Shamir%27s_secret_sharing>`__
1833-
to split the file's encryption key up into multiple parts,
1832+
Having more than one key group allows for the use of `Shamir's secret sharing <https://en.wikipedia.org/wiki/Shamir%27s_secret_sharing>`__
1833+
which splits the file's encryption key up into multiple parts,
18341834
requiring more than one identity to access the file.
18351835
18361836
A key group supports the following keys:
@@ -1857,7 +1857,7 @@ A key group supports the following keys:
18571857
Role: web-server
18581858
aws_profile: foo
18591859
1860-
* ``gcp_kms`` (list of objects): list of GCP KMS ResourceIDs.
1860+
* ``gcp_kms`` (list of objects): list of GCP KMS resource IDs.
18611861
Every object must have the following key:
18621862
18631863
* ``resource_id`` (string): the resource ID.
@@ -1897,21 +1897,21 @@ A key group supports the following keys:
18971897
18981898
* ``merge``: a list of key group objects.
18991899
These will be merged (by concatenating the keys of the same type) into this key group.
1900-
This key is only there to allow concatenation of key groups using YAML anchors, aliases, and overrides.
1900+
This property allows for the concatenation of key groups using YAML anchors, aliases, and overrides.
19011901
19021902
Settings
19031903
********
19041904
19051905
The following keys configure encryption settings:
19061906
19071907
* ``shamir_threshold`` (integer, default ``0``): Must be ``0`` (disabled) or an integer greater or equal to 2.
1908-
Determines the number of key groups from whose one key must be present each to decrypt the file's key.
1908+
Determines the number of key groups that must be present each to decrypt the file's key.
19091909
19101910
* ``mac_only_encrypted`` (boolean, default ``false``): If set to ``true``, only encrypted strings will count towards the file's MAC.
1911-
If set to ``false``, also unencrypted values will be part of the MAC computation.
1911+
If set to ``false``, unencrypted values will also be part of the MAC computation.
19121912
1913-
The following keys configure which values in a file are encrypted.
1914-
Note that at most one of these keys can be used.
1913+
The following keys configure the specific values in a file that should be encrypted.
1914+
Note that at most, one of these keys can be used.
19151915
19161916
* ``unencrypted_suffix`` (string): A value is encrypted if its key **does not** end with this suffix.
19171917
All other values are **encrypted**.

0 commit comments

Comments
 (0)