docs: add AWS, GCP, and Azure secrets provider documentation#400
docs: add AWS, GCP, and Azure secrets provider documentation#400markphelps wants to merge 5 commits intomainfrom
Conversation
Add documentation for three new cloud secrets providers: - AWS Secrets Manager: configuration, authentication via AWS credential chain, custom endpoints for LocalStack - GCP Secret Manager: configuration, ADC and service account auth, regional secrets support - Azure Key Vault: configuration, DefaultAzureCredential auth methods Also updates the pro.mdx page to reflect that cloud provider support is now available (no longer "coming soon"). Closes #398, Closes #390 https://claude.ai/code/session_01KAfEyV81ZochM2Z9dT9CKB
Auto-formatted by Prettier when running `npm run format`. https://claude.ai/code/session_01KAfEyV81ZochM2Z9dT9CKB
PR Review: docs: add AWS, GCP, and Azure secrets provider documentationOverall this is a well-structured PR that delivers on its core purpose. The new cloud provider documentation sections are clear, consistent, and follow the existing patterns established by the Vault and File provider sections. Here is my detailed feedback. What is working welldocs/v2/configuration/secrets.mdx — the main deliverable is solid:
Issues1. Unrelated change to docs/reo.js — should be reverted This file is a third-party analytics snippet (Reo.dev). The change wraps the comma expression in extra parentheses and moves the closing paren. While functionally equivalent, this is almost certainly an accidental Prettier reformatting of a vendor/minified file. Vendor scripts should be kept in their original form or updated by replacing the whole file from the source. This change has no relation to the PR stated purpose. Recommendation: Revert 2. Large unrelated reformatting in docs/v1/guides/migration/launchdarkly/openfeature.mdx This file has 96 additions and 75 deletions consisting entirely of trailing comma additions to JavaScript code samples in documentation. These are syntactically correct and arguably more modern style, but they are completely unrelated to cloud secrets providers. Including them adds noise to the diff and makes it harder to review the actual content changes. They also only affect one guide, suggesting a partial Prettier run rather than an intentional documentation update. Recommendation: Either revert these changes and open a separate cleanup PR, or run Minor suggestions3. New provider cards lack section links The three new Card components in the CardGroup do not include href attributes pointing to the new sections below. Users clicking a card would likely expect to land on the relevant section. For example: <Card title="AWS Secrets Manager" icon="aws" href="#aws-secrets-manager-provider">
Retrieve secrets from AWS Secrets Manager using standard AWS credentials
</Card>The existing File and Vault cards also lack links, so this is a pre-existing gap, but now that there are six options it is worth addressing for discoverability. 4. AWS section is missing AWS_SESSION_TOKEN The AWS environment variables section shows 5. Secret reference key format: clarify path and versioning support The Vault examples show nested paths ( Summary
The documentation content itself is at the right level of detail, covers the essential auth methods for each provider, and follows existing patterns. The main asks before merging are reverting |
- Revert unrelated changes to docs/reo.js (vendor script) - Revert unrelated Prettier reformatting in LaunchDarkly migration guide - Add href links to provider cards for in-page navigation - Add AWS_SESSION_TOKEN for temporary credentials (STS, assumed roles) - Clarify that cloud provider secret keys use exact names (no paths/versions) - Apply Prettier formatting Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Add AWS Secrets Manager, GCP Secret Manager, and Azure Key Vault configuration parameters to the configuration overview reference table. Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
PR Review: AWS, GCP, and Azure Secrets Provider DocumentationOverall this is a solid, well-structured addition. The new provider docs follow the existing patterns nicely and cover the key areas (configuration, auth, env vars). A few things worth looking at: Minor Issues1. Contradictory wording in the AWS env vars section ( The export AWS_SESSION_TOKEN="your_session_token" # Optional: required for temporary credentials (STS, assumed roles)"Optional" and "required" in the same description is contradictory. Suggest rewording to: export AWS_SESSION_TOKEN="your_session_token" # Only needed for temporary credentials (STS, assumed roles)2. All three new provider properties show If these providers are being shipped in a release after v2.0.0 (e.g., v2.1.0 or v2.2.0), these values should reflect the actual release version in which they're introduced. 3. The "Multiple Providers" bullet still reads:
Now that AWS, GCP, and Azure are supported (not just Vault), this bullet undersells the feature. It might be worth updating to something like:
Positive Notes
The three items above are all minor — none of them block this PR. Nice work cleaning up the "coming soon" state and getting these provider docs landed. |
PR Review: Add AWS, GCP, and Azure Secrets Provider DocumentationOverall this is a well-structured addition that follows the existing documentation patterns. The new provider sections are comprehensive and the writing is clear. A few things worth addressing: Issues1. Unrelated change in
|
Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
PR Review: Add AWS, GCP, and Azure Secrets Provider DocumentationThe documentation content is clear, well-organized, and follows the existing patterns. A few items worth addressing before merge: Issues1. Contradictory comment on The inline comment reads: export AWS_SESSION_TOKEN="your_session_token" # Optional: required for temporary credentials (STS, assumed roles)"Optional" and "required" directly contradict each other. Suggested fix: export AWS_SESSION_TOKEN="your_session_token" # Only needed for temporary credentials (STS, assumed roles)2. All three new provider table entries show If these providers are being introduced in a release after v2.0.0, these values should reflect the actual shipping version. Please verify. 3. Inconsistent abbreviation style in The new Azure table entry uses
Per the Microsoft Writing Style Guide, prefer "for example" over "e.g." Recommend updating the 4. Unrelated change in Three packages (acorn, eslint, prettier) had 5. The bullet was not updated alongside the card text above it:
Now that AWS, GCP, and Azure are supported, this undersells the feature. Consider:
SummaryItems 1, 3, and 5 are straightforward one-line fixes. Item 2 needs a version check with whoever owns the release. Item 4 is a cleanup that keeps the PR scope clean. The core documentation content is solid — the provider structure, auth documentation, and examples are all well done. |
Add documentation for three new cloud secrets providers:
Also updates the pro.mdx page to reflect that cloud provider support is now available (no longer "coming soon").
Closes #398, Closes #390
https://claude.ai/code/session_01KAfEyV81ZochM2Z9dT9CKB