Browse Source

docs: reformat pushsecrets documentation to be a list (#4102)

* reformat pushsecrets documentation to be a list

Signed-off-by: twobiers <22715034+twobiers@users.noreply.github.com>

* Use sections instead of a list

Signed-off-by: twobiers <22715034+twobiers@users.noreply.github.com>

---------

Signed-off-by: twobiers <22715034+twobiers@users.noreply.github.com>
Co-authored-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>
Tobi 1 year ago
parent
commit
c2388d2b9d
1 changed files with 6 additions and 5 deletions
  1. 6 5
      docs/guides/pushsecrets.md

+ 6 - 5
docs/guides/pushsecrets.md

@@ -22,15 +22,14 @@ Imagine you have your secrets in GCP and you want to back them up in Azure Key V
 
 There are two ways to push an entire secret without defining all keys individually.
 
-By leaving off the secret key and remote property options.
+### 1. By leaving off the secret key and remote property options.
 
 ```yaml
 {% include 'full-pushsecret-no-key-no-property.yaml' %}
 ```
-
 This will result in all keys being pushed as they are into the remote location.
 
-By leaving off the secret key but setting the remote property option.
+### 2. By leaving off the secret key but setting the remote property option.
 
 ```yaml
 {% include 'full-pushsecret-no-key-with-property.yaml' %}
@@ -38,10 +37,12 @@ By leaving off the secret key but setting the remote property option.
 
 This will _marshal_ the entire secret data and push it into this single property as a JSON object.
 
-!!! warning inline
+!!! warning
+
     This should _ONLY_ be done if the secret data is marshal-able. Values like, binary data cannot be marshaled and will result in error or invalid secret data.
 
-### Key conversion strategy
+
+#### Key conversion strategy
 You can also set `data[*].conversionStrategy: ReverseUnicode` to reverse the invalid character replaced by the `conversionStrategy: Unicode` configuration in the `ExternalSecret` object as [documented here](../guides/getallsecrets.md#avoiding-name-conflicts).
 
 ## Rotate Secrets