Skip to content

docs(deployment): consolidate multi-cloud deployment guides, remove legacy per-cloud tree - #449

Merged
elluvium merged 9 commits into
mainfrom
deployment-docs-restructure
Oct 7, 2026
Merged

elluvium merged 9 commits into
mainfrom
deployment-docs-restructure

Conversation

@sharbuz

@sharbuz sharbuz commented Sep 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

Replaces the legacy per-cloud deployment documentation (docs/admin/deployment/{aws,azure,gcp}/) with a single consolidated, multi-cloud deployment tree using tabbed AWS/Azure/GCP content within each guide.

Changes

  • Add consolidated deployment guides: architecture.mdx, prerequisites.mdx, infrastructure-deployment/{kubernetes,on-vm}.mdx, platform-deployment/{automated,manual}/... covering all three cloud providers via <Tabs>
  • Delete the entire legacy docs/admin/deployment/{aws,azure,gcp}/ tree (88 files) and its sidebar entries
  • Fix all cross-references to the old per-cloud paths (observability, security, configuration, release notes) to point at the new consolidated pages
  • Restructure docs/admin/index.mdx and docs/admin/deployment/index.mdx cards to link to the consolidated guides instead of per-cloud pages
  • Add top-of-page navigation: architecture.mdx/prerequisites.mdx now link to their own Kubernetes/On-VM sections, and on-vm.mdx documents its two deployment methods (scripted/manual), mirroring kubernetes.mdx

Testing

  • Tested locally with npm start
  • All pages render correctly
  • Images display properly
  • Internal links work
  • Sidebar navigation works

Quality Checks

  • npm run check passes (typecheck + lint + commitlint)
  • No MDX compilation errors
  • No raw angle brackets (<text> must be `<text>`)
  • Sidebar references document IDs (not filenames)
  • Images stored locally next to content (not in static/img/)
  • Commit messages follow Conventional Commits
  • No secrets or credentials in documentation

Additional Notes

npm run build passes with no broken links (onBrokenLinks: 'throw').

Generated with AI

Co-Authored-By: codemie-ai codemie.ai@gmail.com

@sharbuz
sharbuz requested a review from elluvium September 30, 2026 15:00
@github-actions

Copy link
Copy Markdown

PR Preview Ready!

Your preview documentation is ready! Visit it here:

Preview URL: http://codemie-docs-pr-previews.s3-website.eu-central-1.amazonaws.com/pr-449/

Note: This preview URL is accessible only while connected to the company VPN.


This preview will be automatically updated when you push new commits to this PR.
Preview files will be deleted when the PR is closed or merged.

sharbuz and others added 5 commits October 2, 2026 10:30
Add infrastructure-deployment/ and platform-deployment/ sections that
consolidate cloud-specific (AWS/GCP/Azure) documentation into unified
guides using cloud-provider tabs instead of separate per-cloud pages.

- infrastructure-deployment/: kubernetes and on-vm guides (all 3 clouds)
- platform-deployment/automated/: scripted Helm deployment for all clouds
- platform-deployment/manual/kubernetes/: 6-step manual install guides
- Add optional props to 4 common partials for depth-sensitive links
- Update sidebars.ts with nested categories for the new sections

Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>
… deployment

extract byo application provisioning from infrastructure-deployment/on-vm.mdx
into a new platform-deployment/manual/on-vm.mdx page; infrastructure guide now
ends after terraform phases and links forward to the platform page

- add platform-deployment/manual/on-vm.mdx with 3-cloud byo deployment steps
- remove byo application phase content from infrastructure-deployment/on-vm.mdx
- update manual/index.md deployment tracks table to include on vm row
- add on-vm to sidebars.ts under manual deployment

Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>
… deployment index

move platform-deployment/manual/on-vm.mdx to automated/ since ./deploy.sh --byo
is a scripted deployment, not a manual one; restructure deployment/index.mdx to
show the logical deployment lifecycle at the top with old cloud-specific guides moved
to the bottom

- move on-vm.mdx from platform-deployment/manual/ to platform-deployment/automated/
- add on-vm to automated/index.md deployment tracks table
- remove on-vm from manual/index.md deployment tracks table
- update sidebars.ts to place on-vm under automated deployment
- update infrastructure-deployment/on-vm.mdx links to point to automated/on-vm
- restructure deployment/index.mdx: infrastructure → platform → configuration →
  update → security at top, cloud-specific guides moved to bottom section

Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>
…to section indexes

split deployment/index.mdx into two logical groups: installation & configuration
(infrastructure, platform, configuration) and maintenance (update, security).
convert section index files from .md to .mdx and replace tables with feature card
grids to match the top-level deployment page style.

- deployment/index.mdx: group into installation & configuration + maintenance sections
- infrastructure-deployment/index.mdx: add feature cards for kubernetes and on vm tracks
- platform-deployment/index.mdx: add feature cards for automated and manual methods
- platform-deployment/automated/index.mdx: add feature cards for kubernetes and on vm
- platform-deployment/manual/index.mdx: add feature card for kubernetes track

Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>
…cloud guides

Delete the legacy docs/admin/deployment/{aws,azure,gcp}/ directories and fix
all references across the site to point at the new consolidated
infrastructure-deployment and platform-deployment guides. Add top-of-page
navigation links to the Kubernetes/On-VM architecture and prerequisites
sections, and add a "two deployment methods" intro to the on-vm guide to
match the kubernetes guide.

Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>
@elluvium
elluvium force-pushed the deployment-docs-restructure branch from 192cc02 to 702b67d Compare October 2, 2026 07:30
sharbuz and others added 4 commits October 5, 2026 10:28
…ernetes/on-vm sub-pages

Restructure architecture.mdx and prerequisites.mdx into directories with
dedicated overview, kubernetes, and on-vm pages, matching the pattern
already used by infrastructure-deployment/.

Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>
…s to config and security pages

Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>
… content

Right-side table of contents was surfacing headings scoped to a single
cloud provider tab, even though only one tab renders at a time. Convert
cloud-specific headings inside <TabItem> blocks to bold text, or to h4
headings (below the site's TOC max level of 3) where a native anchor
must remain valid for existing deep links. The TOC on every audited
page now lists only headings shared across all cloud tabs.

Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>
…ucture

# Conflicts:
#	docs/admin/deployment/common/deployment/accessing-codemie/_accessing-codemie-applications.mdx
@elluvium
elluvium merged commit d2d53e4 into main Oct 7, 2026
4 checks passed
@elluvium
elluvium deleted the deployment-docs-restructure branch October 7, 2026 13:07
@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown

Preview Cleaned Up

The PR preview has been removed from S3.

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.

2 participants