Skip to content

docs(integrations): strip duplicates and add redirects (Phase 3)#1355

Draft
gavinelder wants to merge 3 commits intomasterfrom
docs/integrations-section-phase-3
Draft

docs(integrations): strip duplicates and add redirects (Phase 3)#1355
gavinelder wants to merge 3 commits intomasterfrom
docs/integrations-section-phase-3

Conversation

@gavinelder
Copy link
Copy Markdown
Contributor

Summary

Phase 3 of the Platform Cloud Integrations migration — the destructive cleanup pass. Stacked on top of #1354.

This PR removes the duplicated content the previous phases left in place and turns the URL stubs into proper redirects. After merging, every legacy URL (`/platform-cloud/credentials/`, `/platform-cloud/git/overview`, `/platform-cloud/enterprise/advanced-topics/manual-`) returns a 301 to its new `/platform-cloud/integrations/...` home, and the compute-env pages stop carrying ~700 lines of IAM content each.

What changed

Add redirects. `@docusaurus/plugin-client-redirects@3.9.2` configured in `docusaurus.config.js` with 17 redirect pairs.

Strip compute-env pages. Removed migrated IAM/credentials/storage sections from:

Page Lines (before → after)
`compute-envs/aws-batch.md` 1090 → 406
`compute-envs/aws-cloud.md` 455 → 75
`compute-envs/eks.md` 498 → 144
`compute-envs/azure-batch.md` 520 → 359
`compute-envs/azure-cloud.md` 436 → 89
`compute-envs/google-cloud-batch.md` 254 → 159
`compute-envs/google-cloud.md` 108 → 97

Each stripped page keeps a "Before you start" section linking to the integration page, plus `` anchor stubs for backwards-compatible deep links from blog posts, tickets, and external sites.

Delete legacy directories.

  • `platform-cloud/docs/credentials/` (15 files)
  • `platform-cloud/docs/git/` (1 file)
  • `platform-cloud/docs/enterprise/advanced-topics/manual-{aws,azure}-batch-setup` files (the now-empty parent directory drops out too)

Sidebar. Removed the `Credentials (legacy)` category and the `Compute > Advanced options` sub-category from `cloud-sidebar.json`.

In-repo caller fixes. Repointed links that targeted deleted pages or anchors that no longer exist:

  • `quickstart.md`, `getting-started/{proteinfold,rnaseq}`, `getting-started/quickstart-demo/add-data`
  • `launch/cache-resume.mdx`, `secrets/overview.md`, `resource-labels/overview.md`
  • `data/data-explorer.md`, `seqera-mcp/overview.md`, `supported_software/agent/overview.md`
  • `compute-envs/{aws-batch, eks, azure-batch, gke}.md` (self-links + cross-refs)
  • `integrations/cloud-providers/azure/manual-setup.md` (was pointing at a stripped anchor)

Stacked on

Migration status after this PR

Test plan

  • `docusaurus build` passes (no broken links, no broken anchors)
  • Reviewer: in PR preview, hit `/platform-cloud/credentials/overview` and confirm it 301s to `/platform-cloud/integrations/overview`
  • Reviewer: same for `/platform-cloud/git/overview` → `/platform-cloud/integrations/git-providers/overview`
  • Reviewer: same for `/platform-cloud/enterprise/advanced-topics/manual-aws-batch-setup` → `/platform-cloud/integrations/cloud-providers/aws/manual-setup`
  • Reviewer: open `/platform-cloud/compute-envs/aws-batch` and confirm the page is now scannable, with the "Before you start" section pointing at integrations
  • Reviewer: confirm sidebar no longer shows "Credentials (legacy)" or "Advanced options"

Risks and known limitations

🤖 Generated with Claude Code

gavinelder and others added 3 commits April 27, 2026 16:01
Stand up a dedicated Integrations section under platform-cloud/docs/
to consolidate cloud provider permissions, credentials, git providers,
container registries, data sources, and identity into a single
discoverable home.

Phase 1 duplicates content from compute-envs/, credentials/, git/, and
enterprise/advanced-topics/ rather than removing it, so existing URLs
keep resolving. The old Credentials sidebar entry is preserved as
"Credentials (legacy)" until Phase 3.

Biggest user-messaging win: the AWS IAM/permission content previously
scattered across aws-batch.md (83 IAM mentions), eks.md (71), and
aws-cloud.md (18) is now consolidated into one tabbed
cloud-providers/aws/iam-policies.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…e 2)

Phase 2 of the Integrations migration:
- Adds :::info admonitions to all 14 platform-cloud/docs/credentials/*
  pages and platform-cloud/docs/git/overview.md, pointing readers to the
  new integrations/ location.
- Adds :::tip "canonical reference moved" banners above the migrated
  IAM/permission sections in 7 compute-envs/*.md files (aws-batch,
  aws-cloud, eks, azure-batch, azure-cloud, google-cloud-batch,
  google-cloud).
- Updates 13 internal callers in platform-cloud/docs/ to point at the
  new integrations/* URLs. Convert to absolute /platform-cloud/...
  paths so they survive future moves.

No content is removed in this phase. Old URLs continue to resolve.
Phase 3 will strip the duplicated content and delete legacy paths.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Phase 3 of the Integrations migration — the destructive cleanup pass.

Changes:
- Add @docusaurus/plugin-client-redirects with 17 redirects covering
  /credentials/*, /git/overview, and /enterprise/advanced-topics/manual-*
  to the new /integrations/ paths.
- Strip migrated IAM/credentials/storage content from 7 compute-env
  pages (aws-batch -1090->406 lines, aws-cloud -455->75, eks -498->144,
  azure-batch -520->359, azure-cloud -436->89, google-cloud-batch
  -254->159, google-cloud -108->97). Each stripped page keeps a "Before
  you start" section pointing to the integration page, plus anchor
  stubs for backwards-compatible deep links.
- Delete platform-cloud/docs/credentials/ (15 files), platform-cloud/
  docs/git/ (1 file), and platform-cloud/docs/enterprise/advanced-topics/
  manual-{aws,azure}-batch-setup files. Drop the now-empty enterprise/
  advanced-topics/ directory.
- Remove "Credentials (legacy)" category and "Compute > Advanced
  options" sub-category from cloud-sidebar.json.
- Fix in-repo callers that still pointed at deleted anchors (data-
  explorer, secrets, resource-labels, getting-started/{proteinfold,
  rnaseq}, launch/cache-resume, supported_software/agent, seqera-mcp,
  quickstart, quickstart-demo/add-data, gke, plus self-links inside
  the compute-env pages).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@gavinelder gavinelder changed the base branch from docs/integrations-section-phase-2 to master April 27, 2026 17:12
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.

1 participant