Skip to content

Conversation

@drivera258
Copy link
Contributor

@drivera258 drivera258 commented Apr 21, 2025

Description

  • Adds GUI instructions for general database setup and role creation

Vercel link to overview page

@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Apr 21, 2025
@github-actions
Copy link

CI Results:
All Go tests succeeded! ✅

@drivera258 drivera258 marked this pull request as ready for review April 22, 2025 14:34
@drivera258 drivera258 requested review from a team as code owners April 22, 2025 14:34
@github-actions
Copy link

Build Results:
All builds succeeded! ✅

1. Click on **Connections** tab and click **Create connection +**
1. Click on Database plugin dropdown and select desired plugin ie. **postgreSQL**

![Partial screenshot of the Vault GUI showing the populated "Plugin config" section](/img/gui/databases/pluginConfig.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should limit screenshots to one per tab to avoid overloading the instructions. Pick whichever of the images sets the best context for the user and make that the top image :)

@yhyakuna yhyakuna mentioned this pull request Apr 22, 2025
@yhyakuna
Copy link
Contributor

@drivera258 I created #30325 to suggest format/style changes. But this might overlaps with Sarah's suggestions. So, take my style suggestion as a "possible style" and you don't need to accept my suggestions. I'll keep my PR open for now.

@drivera258
Copy link
Contributor Author

@drivera258 I created #30325 to suggest format/style changes. But this might overlaps with Sarah's suggestions. So, take my style suggestion as a "possible style" and you don't need to accept my suggestions. I'll keep my PR open for now.

thanks @yhyakuna ! I pulled in some of those changes along with Sarah's suggestions here

@yhyakuna
Copy link
Contributor

@schavis I know you suggested to use an unordered list for the UI steps. But I think it should use a numbered list all the way through.

image

@drivera258
Copy link
Contributor Author

@schavis any comment on Yoko's suggestion ? ^

@schavis
Copy link
Contributor

schavis commented May 5, 2025

I agree the steps should be numbered. The reason it's unordered is because we use a partial for the first part of the steps to enforce consistency in how we present those instructions and the platform resets the numbering after the partial 😞

@drivera258
Copy link
Contributor Author

@yhyakuna @schavis - based on the use of screenshots in each step / the limitation of consistent numbering from using the partial; I updated to keep the tabs separate, each using one screenshot.

link in description is updated to reflect the change

@drivera258 drivera258 requested review from schavis and removed request for schavis May 21, 2025 18:09
@drivera258 drivera258 merged commit 0452570 into main May 22, 2025
34 checks passed
@drivera258 drivera258 deleted the ui/VAULT-34186/db-gui-docs branch May 22, 2025 14:21
Erfankam pushed a commit to Erfankam/vault that referenced this pull request Sep 1, 2025
* test doc

* spacing

* update index & scrns

* fixes

* adding static info

* fix wording

* updates

* applying suggested changes

* condense tabs

* removing unused files

* separate tabs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants