Skip to content

docs: remove infra docs from engineering#5614

Open
imeyer wants to merge 3 commits intomainfrom
push-mkzrxmmwqnlm
Open

docs: remove infra docs from engineering#5614
imeyer wants to merge 3 commits intomainfrom
push-mkzrxmmwqnlm

Conversation

@imeyer
Copy link
Copy Markdown
Contributor

@imeyer imeyer commented Apr 7, 2026

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps us understand why this PR exists

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Ran make fmt on /go directory
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Apr 7, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
engineering 🟢 Ready View Preview Apr 7, 2026, 5:16 AM

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 7, 2026

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

Project Deployment Actions Updated (UTC)
dashboard Ready Ready Preview, Comment Apr 8, 2026 0:32am

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 7, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: fe6d8128-fbcc-44f6-885a-43959e5dbeb0

📥 Commits

Reviewing files that changed from the base of the PR and between 56c6e69 and 811c6f8.

📒 Files selected for processing (1)
  • docs/engineering/docs.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/engineering/docs.json

📝 Walkthrough

Walkthrough

This pull request removes 16 infrastructure documentation files and updates docs/engineering/docs.json to prune the "Infra" navigation entries and several whole groups, reflecting those deletions.

Changes

Cohort / File(s) Summary
Navigation Configuration
docs/engineering/docs.json
Pruned "Infra" navigation: removed multiple page entries and deleted entire groups (Observability, Metering, Deployments, Custom Domains, Secrets, Legacy (2025)); kept only core infra/index and a reduced Clusters list.
Infrastructure Documentation
docs/engineering/infra/infra-work.mdx, docs/engineering/infra/domain-connect.mdx
Deleted end-to-end infrastructure workflow guide and custom domain (Domain Connect) documentation.
Cluster Management Documentation
docs/engineering/infra/clusters/kubeconfig.mdx, docs/engineering/infra/clusters/create-region.mdx, docs/engineering/infra/clusters/networks.mdx
Removed kubeconfig generation, multi-region EKS region creation guide, and VPC CIDR/network allocation reference.
Deployment Documentation
docs/engineering/infra/deployments/argocd-debugging.mdx, docs/engineering/infra/deployments/cronjobs.mdx
Deleted ArgoCD debugging/runbook and Kubernetes CronJob → Restate scheduling documentation.
Observability Documentation
docs/engineering/infra/observability/alerting.mdx, docs/engineering/infra/observability/checkly.mdx, docs/engineering/infra/observability/incident-io.mdx
Removed Prometheus alerting rules/runbooks, Checkly synthetic/heartbeat monitoring docs, and incident.io routing/backup instructions.
Secrets Documentation
docs/engineering/infra/secrets/aws-secrets.mdx
Deleted AWS Secrets Manager JSON secret naming, rotation, and usage guide.
Metering Documentation
docs/engineering/infra/metering/gauge.mdx
Removed metering/gauge DaemonSet architecture, ClickHouse schemas, and billing model documentation.
Legacy Infrastructure Documentation
docs/engineering/infra/legacy-2025/github-oidc.mdx, docs/engineering/infra/legacy-2025/github-actions-deploy-role-setup.mdx, docs/engineering/infra/legacy-2025/pulumi-iac-esc.mdx, docs/engineering/infra/legacy-2025/pulumi-infrastructure-architecture.mdx, docs/engineering/infra/legacy-2025/pulumi-workflow.mdx
Removed legacy 2025 docs covering GitHub OIDC/IAM role setup, Pulumi workflows, Pulumi + ESC integration, and Pulumi infrastructure architecture.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • docs: eng docs #5352 — Also modifies docs/engineering/docs.json and prunes/updates the Infra navigation and related infra docs, indicating closely related documentation restructuring.
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is largely incomplete and off-topic. It contains only the template with placeholders and unchecked checkboxes, providing no actual explanation of why the documentation was removed or what the changes entail. Fill in the description template with actual content: summarize what docs were removed and why, select the appropriate change type (likely 'Chore'), describe testing approach, and check applicable checklist items.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: removal of infrastructure documentation from the engineering section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch push-mkzrxmmwqnlm

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

"pages": [
"infra/clusters/kubeconfig",
"infra/clusters/create-region",
"infra/clusters/delete-cluster",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

why are we leaving some pages?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@chronark chronark enabled auto-merge April 7, 2026 16:49
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.

4 participants