Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(secrets-engines): Add database secrets engine docs #1036

Merged
merged 2 commits into from
Sep 2, 2023

Conversation

amiewei
Copy link
Contributor

@amiewei amiewei commented Aug 27, 2023

Add docs for the database secrets engine - #453

I've added docs/code examples for the majority of methods but missing the static role related methods. I plan on adding them at a later time once I test them.

@amiewei amiewei requested a review from a team as a code owner August 27, 2023 21:00
@briantist briantist self-assigned this Aug 28, 2023
@briantist briantist added documentation documentation updates and/or requests for expanded documentation secrets engines generally related to a Vault secrets engine database database secrets engine labels Aug 28, 2023
@briantist briantist added this to the 1.2.0 milestone Aug 28, 2023
@codecov
Copy link

codecov bot commented Aug 28, 2023

Codecov Report

Merging #1036 (ff084f3) into main (9172473) will increase coverage by 0.00%.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1036   +/-   ##
=======================================
  Coverage   84.99%   85.00%           
=======================================
  Files          65       65           
  Lines        3133     3135    +2     
=======================================
+ Hits         2663     2665    +2     
  Misses        470      470           

see 1 file with indirect coverage changes

@briantist
Copy link
Contributor

Hi @amiewei , welcome! Thank you for putting up this much-needed documentation for the database secrets engine. I'll take a closer look at the content itself as soon as I can.

In the meantime, it seems there are a lot of changes to the poetry configuration in here that we're not quite ready to make yet. Would you be able to revert the changes to poetry.lock and pyproject.toml? If there's something about those changes that are required for the documentation updates, please let me know.

Thanks!

@briantist briantist mentioned this pull request Aug 28, 2023
@amiewei amiewei force-pushed the database branch 2 times, most recently from 69c02c9 to 302fcd0 Compare August 28, 2023 17:55
@amiewei
Copy link
Contributor Author

amiewei commented Aug 28, 2023

heyhey, thanks for looking at this quickly :)

I tried reverting the poetry.lock and pyproject.toml files by essentially deleting those two files locally, then copying the poetry.lock from upstream and reinstalling the packages to auto-regenerate the pyproject.toml. Looking at the diff, I think there are still some differences comparing the auto-generated toml file from the original one.

im not well versed in poetry - pun intended, so let me know if this is ok or if there's a better way to revert it 😅. Regardless, i updated the commit based on the above

@briantist
Copy link
Contributor

im not well versed in poetry - pun intended

😆 neither am I, either kind

the auto-generated toml file from the original one

Do you know why the file is being auto-generated at all for this change? Are there some commands you're running locally?

I figured if you did git checkout main -- poetry.lock pyproject.toml that should restore the files from main, and then if you commit those and push, it should result in no changes to them in this PR, but I'm still wondering how they got changed in the first place.

@amiewei
Copy link
Contributor Author

amiewei commented Aug 28, 2023

alright i used your command thank you and updated the commit.. 3rd time is the charm? 😅

Copy link
Contributor

@briantist briantist left a comment

Choose a reason for hiding this comment

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

ok, finally had a chance to look at this more closely. It's really great! All my suggested changes are really minor.

For sentence-ending punctuations on descriptions, I used colon : because one of yours had it already, but I'd also be fine with making them all period/full-stop . instead.

If you like the suggestions as-is and want to commit from the GitHub UI, use the Files tab in the PR to look at them, that way you can click "Add suggestion to batch" and then commit all the ones you want at once.

Also fine to make changes locally and push them up.

docs/usage/secrets_engines/database.rst Outdated Show resolved Hide resolved
docs/usage/secrets_engines/database.rst Show resolved Hide resolved
docs/usage/secrets_engines/database.rst Outdated Show resolved Hide resolved
docs/usage/secrets_engines/database.rst Outdated Show resolved Hide resolved
docs/usage/secrets_engines/database.rst Outdated Show resolved Hide resolved
docs/usage/secrets_engines/database.rst Outdated Show resolved Hide resolved
docs/usage/secrets_engines/database.rst Outdated Show resolved Hide resolved
docs/usage/secrets_engines/database.rst Outdated Show resolved Hide resolved
docs/usage/secrets_engines/database.rst Outdated Show resolved Hide resolved
docs/usage/secrets_engines/database.rst Outdated Show resolved Hide resolved
@briantist
Copy link
Contributor

Also if you're ok me pushing these changes, I can take care of that for you and get this merged in.

@amiewei
Copy link
Contributor Author

amiewei commented Sep 2, 2023

looks good! thanks for going through it :)

Copy link
Contributor

@briantist briantist left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks so much for improving the documentation. I think you've seen this already but we're looking for help in the project and these improvements are a huge help, hope to see you around with more changes!

@briantist briantist merged commit 0ae58b6 into hvac:main Sep 2, 2023
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
database database secrets engine documentation documentation updates and/or requests for expanded documentation secrets engines generally related to a Vault secrets engine
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants