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(topics): add external variable providers guide #203

Merged
merged 1 commit into from
Jul 23, 2024

Conversation

vdice
Copy link
Contributor

@vdice vdice commented Jul 17, 2024

Adds an External Variable Providers guide.

For the Azure Key Vault example, I wasn't sure how much actual application and Key Vault setup to show, since it is well-documented in the upstream sample app README. Thoughts?

Ref #199

@bacongobbler
Copy link
Contributor

bacongobbler commented Jul 17, 2024

I wasn't sure how much actual application and Key Vault setup to show, since it is well-documented in the upstream sample app README. Thoughts?

My only concern here would be if the upstream sample app README may be moved or updated in the future. I'm not sure that the content inside the documentation would be able to stand on its own if the linked README were to be removed in the future.

However, this looks great. I think it might be worth it to copy those steps into the guide in a follow-up PR (I'd be happy to do that). That way the reader can follow the guide and copy the steps without having to reference back and forth between several documents. This does run the risk of having to update two locations if these steps were to change, however I think this is a more suitable alternative than a potential scenario where a user follows the guide that links to a github page that no longer exists.

@vdice vdice force-pushed the docs/external-variable-providers branch from 80f8357 to 08b2a5e Compare July 18, 2024 17:26
@vdice
Copy link
Contributor Author

vdice commented Jul 18, 2024

@bacongobbler good call. I've update the guide in both Vault and Azure Key Vault sections to be more standalone. Please take a look when convenient.

@vdice vdice requested a review from bacongobbler July 18, 2024 17:26
@vdice vdice force-pushed the docs/external-variable-providers branch 2 times, most recently from 9c7e065 to 9e69934 Compare July 18, 2024 17:34
@vdice vdice force-pushed the docs/external-variable-providers branch from 9e69934 to 258036c Compare July 18, 2024 17:36
@vdice vdice mentioned this pull request Jul 18, 2024
4 tasks
@vdice vdice merged commit 549cf83 into spinkube:main Jul 23, 2024
1 check passed
@vdice vdice deleted the docs/external-variable-providers branch July 23, 2024 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants