-
Notifications
You must be signed in to change notification settings - Fork 3
Consolidate provider authentication documentation and point to Marketplace for release notes #993
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
Conversation
…se notes Removes provider-specific release notes and authentication documentation from individual provider directories, replacing them with centralized documentation and marketplace links. This reduces duplication and ensures users always have access to the latest release information through the Marketplace. The providers index now organizes providers into clear categories (major cloud providers and platform providers) with direct marketplace links.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Update AWS provider package version to v2.1.1 - Add missing Azure federated credential name and description fields - Update GCP provider package version to v2.1.0 - Replace ControllerConfig with DeploymentRuntimeConfig in GCP sections - Update GCP Workload Identity to use DeploymentRuntimeConfig - Update GCP Service Account Impersonation to use DeploymentRuntimeConfig - Add expanded documentation for AWS access keys, WebIdentity, and IRSA - Add expanded documentation for Azure service principals and managed identity - Add comprehensive examples and explanations throughout
- Fix Vale linting errors in authentication.md: - Replace "e.g.," with "for example" - Wrap "cron" in backticks - Fix broken links to old provider authentication pages: - Update migrate-hcl.md with new authentication anchors - Update migrate-provider-tf.md with new authentication anchors - Update provider-authentication.md (UXP concepts) links - Update oidc.md with new OIDC authentication anchors - Update vercel.json redirects: - Redirect old /providers/provider-*/authentication paths - Redirect old /manuals/packages/providers/provider-*/authentication paths - All redirects now point to unified /manuals/packages/providers/authentication All links now point to the unified authentication page with appropriate section anchors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "destination": "/manuals/packages/providers/authentication#aws-authentication", | ||
| "permanent": true | ||
| }, | ||
| { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update provider rewrites to existing destinations
The per‑provider redirects still point to /manuals/packages/providers/provider-aws (and similar paths for Azure, GCP, Helm, and Kubernetes), but those pages were deleted in this commit. Hitting legacy URLs such as /providers/provider-aws will therefore 301 to a non-existent path and return a 404 instead of the new consolidated docs or the Marketplace listing. The redirect targets should be updated to /manuals/packages/providers/ or the relevant Marketplace URLs so incoming traffic from old links keeps working.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "destination": "/manuals/packages/providers/authentication#aws-authentication", | ||
| "permanent": true | ||
| }, | ||
| { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update provider rewrites to existing destinations
The per‑provider redirects still point to /manuals/packages/providers/provider-aws (and similar paths for Azure, GCP, Helm, and Kubernetes), but those pages were deleted in this commit. Hitting legacy URLs such as /providers/provider-aws will therefore 301 to a non-existent path and return a 404 instead of the new consolidated docs or the Marketplace listing. The redirect targets should be updated to /manuals/packages/providers/ or the relevant Marketplace URLs so incoming traffic from old links keeps working.
Useful? React with 👍 / 👎.
This PR consolidates provider documentation by removing provider-specific release notes and authentication documentation from individual provider directories. Instead, it centralizes authentication guidance and directs users to the Marketplace for release notes.
Changes
docs/manuals/packages/providers/authentication.mdDirectory Structure Visualization
Before
After
Benefits
Impact
Type of change
Checklist
make lintlocally (or will fix Vale suggestions in review)Additional notes