Skip to content

Conversation

@jeanduplessis
Copy link
Contributor

@jeanduplessis jeanduplessis commented Oct 22, 2025

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

  • Removed provider-specific release notes (previously duplicated in docs and on Marketplace)
  • Removed provider-specific authentication docs for AWS, Azure, GCP, Kubernetes, and Helm
  • Added centralized authentication guide at docs/manuals/packages/providers/authentication.md
  • Updated providers index page with organized tables (major cloud providers and platform providers)
  • Added direct Marketplace links for each provider

Directory Structure Visualization

Before

  docs/manuals/packages/providers/
  ├── index.md
  ├── provider-aws/
  │   ├── authentication.md
  │   └── index.md (release notes)
  ├── provider-azure/
  │   ├── authentication.md
  │   └── index.md (release notes)
  ├── provider-azuread/
  │   └── index.md (release notes)
  ├── provider-gcp/
  │   ├── authentication.md
  │   └── index.md (release notes)
  ├── provider-helm/
  │   └── index.md (release notes)
  ├── provider-kubernetes/
  │   ├── authentication.md
  │   └── index.md (release notes)
  └── provider-terraform/
      └── index.md

After

  docs/manuals/packages/providers/
  ├── index.md (enhanced with provider tables and Marketplace links)
  ├── authentication.md (centralized guide for all providers)
  └── provider-terraform/
      └── index.md (migration guides)

Benefits

  1. Single source of truth: Release notes are now maintained only on the Marketplace
  2. Reduced duplication: No need to sync release notes between docs and Marketplace
  3. Simpler maintenance: Less documentation to keep updated
  4. Better discoverability: Clear provider tables with direct Marketplace links
  5. Centralized auth docs: One place to document authentication patterns

Impact

  • Users looking for release notes will be directed to the Marketplace (which is already the primary source)
  • Authentication documentation is now centralized but still covers all providers
  • Provider Terraform retains its migration guide documentation

Type of change

  • Bug fix (typo, broken link, incorrect info)
  • Content update (new info, clarification, reorganization)
  • New content (new page, section, or guide)

Checklist

  • I ran make lint locally (or will fix Vale suggestions in review)
  • Links work and point to the right places
  • If this adds new content, I tested the examples/instructions

Additional notes

…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.
@vercel
Copy link

vercel bot commented Oct 22, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Oct 23, 2025 3:16pm

- 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.
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a 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
},
{

Choose a reason for hiding this comment

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

P1 Badge 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 👍 / 👎.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a 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
},
{

Choose a reason for hiding this comment

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

P1 Badge 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 👍 / 👎.

@jeanduplessis jeanduplessis merged commit 1dcd6e2 into main Oct 23, 2025
3 checks passed
@tr0njavolta tr0njavolta deleted the no-provider-release-notes branch December 8, 2025 15:50
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