Docs: Add updated screenshots to kv subkey docs (hashicorp#29067)

* clarify subkey read in GUI * add screenshots * add to index * update kv nav steps * update alt text for screenshot * update steps * edits * fix build error and simplify path structure * fix paths * missed one * missed another one >_< * Update website/content/docs/secrets/kv/kv-v2/cookbook/write-data.mdx --------- Co-authored-by: Sarah Chavis <[email protected]>
fopina · Dec 4, 2024 · bc09d9a · bc09d9a
1 parent a67e062
commit bc09d9a
Showing 22 changed files with 37 additions and 45 deletions.
diff --git a/website/content/docs/auth/saml/adfs.mdx b/website/content/docs/auth/saml/adfs.mdx
@@ -55,7 +55,7 @@ Configure your Vault instance to work with Active Directory Federation Services
 
 <Tab heading="Vault GUI" group="gui">
 
-@include 'gui-page-instructions/enable-authn-plugin.mdx'
+@include 'gui-instructions/enable-authn-plugin.mdx'
 
 - Enable the SAML plugin:
 

diff --git a/website/content/docs/auth/saml/link-vault-group-to-ad.mdx b/website/content/docs/auth/saml/link-vault-group-to-ad.mdx
@@ -52,7 +52,7 @@ $ vault secrets enable -path=adfs-kv kv-v2
 
 <Tab heading="Vault GUI" group="gui">
 
-@include 'gui-page-instructions/enable-secrets-plugin.mdx'
+@include 'gui-instructions/enable-secrets-plugin.mdx'
 
 - Enable the KV plugin:
 
@@ -102,7 +102,7 @@ EOF
 
 <Tab heading="Vault GUI" group="gui">
 
-@include 'gui-page-instructions/create-acl-policy.mdx'
+@include 'gui-instructions/create-acl-policy.mdx'
 
 - Set the policy details and click **Create policy**:
 
@@ -161,7 +161,7 @@ EOF
 
 <Tab heading="Vault GUI" group="gui">
 
-@include 'gui-page-instructions/create-group.mdx'
+@include 'gui-instructions/create-group.mdx'
 
 - Follow the prompts to create an external group with the following
   information:

diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/custom-metadata.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/custom-metadata.mdx
@@ -85,9 +85,8 @@ destroyed        false
 
 <Tab heading="GUI" group="gui">
 
-@include 'gui-page-instructions/select-kv-mount.mdx'
+@include 'gui-instructions/plugins/kv/open-overview.mdx'
 
-- Click through the path segments to select the relevant secret path.
 - Select the **Metadata** tab.
 - Click **Edit metadata >**.
 - Set a new key name and value under **Custom metadata**.

diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/delete-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/delete-data.mdx
@@ -95,9 +95,9 @@ destroyed        false
 
 <Tab heading="GUI" group="gui">
 
-@include 'gui-page-instructions/select-kv-mount.mdx'
+@include 'gui-instructions/plugins/kv/open-overview.mdx'
 
-- Click through the path segments to select the relevant secret path.
+- Select the **Secret** tab.
 - Select the appropriate data version from the **Version** dropdown.
 - Click **Delete**.
 - Select **Delete this version** to delete the selected version or

diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/destroy-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/destroy-data.mdx
@@ -92,9 +92,9 @@ destroyed        true
 
 <Tab heading="GUI" group="gui">
 
-@include 'gui-page-instructions/select-kv-mount.mdx'
+@include 'gui-instructions/plugins/kv/open-overview.mdx'
 
-- Click through the path segments to select the relevant secret path.
+- Select the **Secret** tab.
 - Select the appropriate data version from the **Version** dropdown.
 - Click **Destroy**.
 - Click **Confirm**.

diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/max-versions.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/max-versions.mdx
@@ -84,9 +84,8 @@ destroyed        false
 
 <Tab heading="GUI" group="gui">
 
-@include 'gui-page-instructions/select-kv-mount.mdx'
+@include 'gui-instructions/plugins/kv/open-overview.mdx'
 
-- Click through the path segments to select the relevant secret path.
 - Select the **Metadata** tab.
 - Click **Edit metadata >**.
 - Update the **Maximum number of versions** field.

diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/patch-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/patch-data.mdx
@@ -114,9 +114,10 @@ push the update to the plugin.
 
 @include 'alerts/enterprise-only.mdx'
 
-@include 'gui-page-instructions/select-kv-data.mdx'
+@include 'gui-instructions/plugins/kv/open-overview.mdx'
 
-- Click **Patch latest version +** on the key/value page.
+- Select the **Secret** tab.
+- Click **Patch latest version +**.
 - Edit the values you want to update.
 - Click **Save**.
 

diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/read-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/read-data.mdx
@@ -82,9 +82,9 @@ $ vault kv get -mount shared -field prod dev/square-api
 
 <Tab heading="GUI" group="gui">
 
-@include 'gui-page-instructions/select-kv-mount.mdx'
+@include 'gui-instructions/plugins/kv/open-overview.mdx'
 
-- Click through the path segments to select the relevant secret path.
+- Select the **Secret** tab.
 - Click the eye icon to view the desired key value.
 
 ![Partial screenshot of the Vault GUI showing two key/value pairs at the path dev/square-api. The "prod" key is visible](/img/gui/kv/read-data.png)

diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/read-subkey.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/read-subkey.mdx
@@ -21,8 +21,8 @@ Read the available subkeys on an existing data path in the `kv` v2 plugin.
 
 <Tab heading="CLI" group="cli">
 
-Use `vault read` with the `/subkeys` metadata path retrieve a list of available
-subkeys on the given path. 
+Use `vault read` with the `/subkeys` path to retrieve a list of secret data
+subkeys at the given path. 
 
 ```shell-session
 $ vault read <mount_path>/subkeys/<secret_path>
@@ -50,12 +50,14 @@ subkeys     map[prod:<nil> sandbox:<nil> smoke:<nil>]
 
 <Tab heading="GUI" group="gui">
 
-@include 'gui-page-instructions/select-kv-mount.mdx'
+@include 'alerts/enterprise-only.mdx'
 
-- Click through the path segments to select the relevant secret path.
-- Note the subkeys listed on the data page.
+@include 'gui-instructions/plugins/kv/open-overview.mdx'
 
-![Partial screenshot of the Vault GUI showing two key/value pairs at the path dev/square-api. The "prod" key is visible](/img/gui/kv/read-data.png)
+You can read a list of available subkeys for the target path in the **Subkeys**
+card.
+
+![Partial screenshot of the Vault GUI showing subkeys "prod" and "sandbox" for secret data at path dev/square-api.](/img/gui/kv/overview-page.png)
 
 </Tab>
 

diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/undelete-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/undelete-data.mdx
@@ -90,9 +90,9 @@ destroyed        false
 
 <Tab heading="GUI" group="gui">
 
-@include 'gui-page-instructions/select-kv-mount.mdx'
+@include 'gui-instructions/plugins/kv/open-overview.mdx'
 
-- Click through the path segments to select the relevant secret path.
+- Select the **Secret** tab.
 - Select the appropriate data version from the **Version** dropdown.
 - Click **Undelete**.
 

diff --git a/website/content/docs/secrets/kv/kv-v2/cookbook/write-data.mdx b/website/content/docs/secrets/kv/kv-v2/cookbook/write-data.mdx
@@ -72,10 +72,11 @@ The Vault GUI forcibly converts non-string keys to strings before writing data.
 To preserve non-string values, use the JSON toggle to write your key/value data
 as JSON.
 
-@include 'gui-page-instructions/select-kv-mount.mdx'
+@include 'gui-instructions/plugins/kv/open-overview.mdx'
 
-- Click through the path segments to select the relevant secret path.
-- Click **Create new version +**.
+- Click **Create new +** from one of the following tabs:
+    - **Overview** tab: in the "Current version" card.
+    - **Secret** tab: in the toolbar.
 - Set a new key name and value.
 - Use the **Add** button to set additional key/value pairs.
 - Click **Save** to write the new version data.

diff --git a/website/content/docs/secrets/kv/kv-v2/index.mdx b/website/content/docs/secrets/kv/kv-v2/index.mdx
@@ -35,6 +35,7 @@ Basic examples:
 - [Set max data versions](/vault/docs/secrets/kv/kv-v2/cookbook/max-versions)
 - [Write data](/vault/docs/secrets/kv/kv-v2/cookbook/write-data)
 - [Patch and update data](/vault/docs/secrets/kv/kv-v2/cookbook/patch-data)
+- [Read subkeys](/vault/docs/secrets/kv/kv-v2/cookbook/read-subkey)
 - [Soft delete data](/vault/docs/secrets/kv/kv-v2/cookbook/delete-data)
 - [Restore soft deleted data](/vault/docs/secrets/kv/kv-v2/cookbook/undelete-data)
 - [Destroy data](/vault/docs/secrets/kv/kv-v2/cookbook/destroy-data)

diff --git a/website/content/docs/secrets/kv/kv-v2/random-string.mdx b/website/content/docs/secrets/kv/kv-v2/random-string.mdx
@@ -268,9 +268,10 @@ g0bc0b6W3ii^SXa@*ie5
 
 <Tab heading="GUI" group="gui">
 
-@include 'gui-page-instructions/select-kv-mount.mdx'
+@include 'gui-instructions/plugins/kv/open-overview.mdx'
+
+- Select the **Secret** tab.
 
-- Click through the path segments to select the relevant secret path.
 - Click the eye icon to view the desired key value.
 
 ![Partial screenshot of the Vault GUI showing the randomized string stored at the path dev/seeds.](/img/gui/kv/random-string.png)

diff --git a/website/content/docs/secrets/kv/kv-v2/setup.mdx b/website/content/docs/secrets/kv/kv-v2/setup.mdx
@@ -52,7 +52,7 @@ $ vault secrets enable -path <mount_path> kv-v2
 
 <Tab heading="GUI" group="gui">
 
-@include 'gui-page-instructions/enable-secrets-plugin.mdx'
+@include 'gui-instructions/enable-secrets-plugin.mdx'
 
 - Select the "KV" plugin.
 
@@ -221,7 +221,7 @@ $ vault policy write "KV-access-policy" ./kv-policy.hcl
 
 <Tab heading="GUI" group="gui">
 
-@include 'gui-page-instructions/create-acl-policy.mdx'
+@include 'gui-instructions/create-acl-policy.mdx'
 
 - Provide a name for the policy and upload the policy definition file.
 

diff --git a/...i-page-instructions/create-acl-policy.mdx → ...ls/gui-instructions/create-acl-policy.mdx b/...i-page-instructions/create-acl-policy.mdx → ...ls/gui-instructions/create-acl-policy.mdx
diff --git a/...ls/gui-page-instructions/create-group.mdx → ...artials/gui-instructions/create-group.mdx b/...ls/gui-page-instructions/create-group.mdx → ...artials/gui-instructions/create-group.mdx
diff --git a/...page-instructions/enable-authn-plugin.mdx → .../gui-instructions/enable-authn-plugin.mdx b/...page-instructions/enable-authn-plugin.mdx → .../gui-instructions/enable-authn-plugin.mdx
diff --git a/...ge-instructions/enable-secrets-plugin.mdx → ...ui-instructions/enable-secrets-plugin.mdx b/...ge-instructions/enable-secrets-plugin.mdx → ...ui-instructions/enable-secrets-plugin.mdx
diff --git a/.../gui-page-instructions/select-kv-data.mdx → ...instructions/plugins/kv/open-overview.mdx b/.../gui-page-instructions/select-kv-data.mdx → ...instructions/plugins/kv/open-overview.mdx
@@ -1,4 +1,4 @@
-- Open the data page for your `kv` plugin:
+- Open the **Overview** screen for your secret path:
 
     1. Open the GUI for your Vault instance.
 
@@ -9,6 +9,4 @@
 
     1. Select the mount path for your `kv` plugin.
 
-    1. Click through the path segments to select the relevant secret path.
-
-    1. Select the **Secret** tab
+    1. Click through the path segments to select the relevant secret path.
diff --git a/website/content/partials/gui-page-instructions/select-kv-mount.mdx b/website/content/partials/gui-page-instructions/select-kv-mount.mdx
diff --git a/website/public/img/gui/kv/overview-page.png b/website/public/img/gui/kv/overview-page.png
diff --git a/website/public/img/gui/kv/patch-reveal-subkeys.png b/website/public/img/gui/kv/patch-reveal-subkeys.png