What
Extract provider-agnostic content from docs/docs/how-tos/providers/aws.mdx into shared how-to pages that each provider page references as previous or next steps. The three sections we already know are shared:
- GitOps repository
- Secrets and credentials (provider-specific credential blocks stay in each provider page)
- First sign-in
When the next provider page lands, audit it against AWS to see if more sections are duplicated and should be extracted too.
Why
Those three sections are already provider-agnostic. Once we add a second provider how-to, the content will be duplicated across pages, creating maintenance burden and a worse reading experience. Additional shared content may surface as more providers are added.
The refactor was raised by @marcelovilla in a review thread on PR #673.
We deferred this in PR #673 because the shared structure is easier to design once at least one other provider page exists.
Trigger
Pick this up when the next provider how-to (Azure or Existing) is opened as a PR. That is when the real duplication becomes visible and the shared structure can be designed against two consumers.
Acceptance criteria
References
What
Extract provider-agnostic content from
docs/docs/how-tos/providers/aws.mdxinto shared how-to pages that each provider page references as previous or next steps. The three sections we already know are shared:When the next provider page lands, audit it against AWS to see if more sections are duplicated and should be extracted too.
Why
Those three sections are already provider-agnostic. Once we add a second provider how-to, the content will be duplicated across pages, creating maintenance burden and a worse reading experience. Additional shared content may surface as more providers are added.
The refactor was raised by @marcelovilla in a review thread on PR #673.
We deferred this in PR #673 because the shared structure is easier to design once at least one other provider page exists.
Trigger
Pick this up when the next provider how-to (Azure or Existing) is opened as a PR. That is when the real duplication becomes visible and the shared structure can be designed against two consumers.
Acceptance criteria
References