Skip to content

Extract provider-agnostic sections from provider how-to pages #680

Description

@khuyentran1401

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

  • Review both provider pages side by side and identify all duplicated sections (the three above as a starting point, plus anything else found)
  • Each identified shared section lives in its own how-to page
  • Each provider page links to the shared pages at the right step
  • Sidebar updated to surface the shared pages
  • Docusaurus build passes with no broken links

References

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

Priority

None yet

Start date

None yet

Target date

None yet

Size

None yet

Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions