Skip to content

docs: expand Divert setup, shared environments, and troubleshooting - #1155

Draft
codyjlandstrom wants to merge 4 commits into
mainfrom
cody/divert-docs-feedback
Draft

docs: expand Divert setup, shared environments, and troubleshooting#1155
codyjlandstrom wants to merge 4 commits into
mainfrom
cody/divert-docs-feedback

Conversation

@codyjlandstrom

@codyjlandstrom codyjlandstrom commented Feb 4, 2026

Copy link
Copy Markdown
Contributor

Expands the Divert docs based on the feedback from the initial release, and reconciles the branch with everything that landed on main since February.

What this adds

  • A setup path on the core concepts page (core/divert.mdx): prerequisites by role, driver configuration, shared environment creation, manifest configuration, and verification. Each step links to the detailed guide instead of repeating it.
  • Setting Up Shared Environments: how to create the shared namespace (Global Preview Environment vs regular Namespace), shared vs per-developer databases (with the Volume Snapshots tie-in), the hybrid pattern, and verification steps.
  • Troubleshooting, split by audience: developer issues (header propagation, routing verification, a diagnostic checklist) live in Using Divert; admin issues (driver configuration, ingress controllers, sidecar injection) live in Configure Divert. The core page links to both instead of carrying a third copy.

Corrections from the original draft

  • Linkerd is documented as optional for the nginx driver. The original draft said it was required. Without Linkerd, the nginx driver routes at the ingress level; installing Linkerd extends header-based routing to service-to-service calls. This matches the CLI behavior and the chart.
  • Removed a divert.debug manifest field that does not exist in the CLI schema.
  • Removed an api.logLevel Helm value that does not exist in the chart.
  • Dropped the inline Istio installation instructions (they duplicated the newer Istio installation guide and pointed at the old sample repo). The page links to the guide instead.
  • Dropped the versioned_docs/version-1.40 copies. 1.47 is current, so this content targets src/content/ only.

Merge with main

Merged main and kept everything that landed since this branch was opened: the Istio installation guide (#1177), the ingress controllers architecture section (#1187), the okteto-community sample repo URLs (#1178, #1196), and the virtualServices/hosts field documentation (#1197). Also fixed two pre-existing broken relative links in the Configure Divert "Next Steps" section.

Style pass done per STYLE_GUIDE.md. yarn build passes.

🤖 Generated with Claude Code

@netlify

netlify Bot commented Feb 4, 2026

Copy link
Copy Markdown

Deploy Preview for okteto-docs ready!

Name Link
🔨 Latest commit 31f4827
🔍 Latest deploy log https://app.netlify.com/projects/okteto-docs/deploys/6982e90ffae84f0008694070
😎 Deploy Preview https://deploy-preview-1155--okteto-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Aug 18, 2026

Copy link
Copy Markdown

Deploy Preview for okteto-docs ready!

Name Link
🔨 Latest commit 5794c59
🔍 Latest deploy log https://app.netlify.com/projects/okteto-docs/deploys/6a853458df67a9000969e313
😎 Deploy Preview https://deploy-preview-1155--okteto-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

- Document Linkerd as optional for the nginx driver: ingress-level
  routing works without it, Linkerd extends routing to
  service-to-service calls. The original draft said it was required.
- Remove the divert.debug manifest field and the api.logLevel Helm
  value; neither exists in the CLI schema or the chart.
- Replace the step-by-step getting started section with a role-based
  setup path that links to the detailed guides instead of repeating
  their content.
- Split troubleshooting by audience: developer issues in Using Divert,
  admin issues in Configure Divert. The core page links to both.
- Keep everything that landed on main after this branch was opened:
  the Istio installation guide, the ingress controller architecture
  section, the okteto-community sample URLs, and the
  virtualServices/hosts field docs.
- Drop the versioned_docs/version-1.40 copies; 1.47 is current and
  new content targets src/content only.
- Style pass per STYLE_GUIDE.md.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: Cody Landstrom <cody@okteto.com>
@codyjlandstrom codyjlandstrom changed the title Cody/divert docs feedback docs: expand Divert setup, shared environments, and troubleshooting Aug 19, 2026
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