Skip to content

feat: offload legacy enterprise docs to archive site#1187

Draft
llewellyn-sl wants to merge 1 commit intomasterfrom
codex/research-enterprise-versions-offload
Draft

feat: offload legacy enterprise docs to archive site#1187
llewellyn-sl wants to merge 1 commit intomasterfrom
codex/research-enterprise-versions-offload

Conversation

@llewellyn-sl
Copy link
Contributor

Summary

  • add DOCS_SITE_MODE-driven main vs enterprise-archive behavior for Platform Enterprise docs
  • move Enterprise 23.1-23.4 into an archive-only build and add main-site redirects plus a legacy/supported version split in the UI
  • make archive mode previewable locally without fetching unrelated OSS doc repos

Validation

  • DOCS_SITE_MODE=enterprise-archive ./node_modules/.bin/docusaurus build --out-dir build-archive
  • DOCS_SITE_MODE=main EXCLUDE_MULTIQC=true EXCLUDE_WAVE=true ./node_modules/.bin/docusaurus build --out-dir build-main
  • DOCS_SITE_MODE=enterprise-archive npm run dev

Notes

  • 23.1/23.2 legacy sidebars needed cleanup because they referenced docs that no longer exist on master
  • archive builds still surface pre-existing broken-link/broken-anchor warnings inside legacy docs content
  • follow-up deployment work is still needed after merge: create the frozen archive branch/site and configure docs-archive.seqera.io in Netlify

@netlify
Copy link

netlify bot commented Mar 9, 2026

Deploy Preview for seqera-docs ready!

Name Link
🔨 Latest commit 23ac025
🔍 Latest deploy log https://app.netlify.com/projects/seqera-docs/deploys/69ae878b39fd18000846aea9
😎 Deploy Preview https://deploy-preview-1187--seqera-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.

@llewellyn-sl
Copy link
Contributor Author

@claude review

@claude
Copy link

claude bot commented Mar 9, 2026

Claude finished @llewellyn-sl's task —— View job


PR Review: Enterprise Docs Archive Feature

This is a well-architected implementation for offloading legacy enterprise documentation to an archive site. Here's my comprehensive review:

Architecture & Design ✅

Excellent approach: The DOCS_SITE_MODE environment variable strategy cleanly separates main site (docs.seqera.io) from archive site (docs-archive.seqera.io) functionality.

Key strengths:

  • Clean separation of concerns with mode-driven configuration
  • Proper version segregation (24.1+ on main, 23.1-23.4 on archive)
  • Smart build optimization (skips OSS docs fetch for archive mode)

Code Quality Review

docusaurus.config.js - Excellent

  • Well-structured version management with enterpriseVersionsBySiteMode
  • Proper conditional plugin loading to reduce archive site bloat
  • Good use of custom fields for cross-component communication
  • Smart announcement bar for archive site user guidance

React Components - Very Good

  • VersionSwitcher/index.tsx: Clean implementation with proper TypeScript interfaces, good UX with "Legacy versions" external link
  • Navbar/Content/index.tsx: Proper conditional rendering for archive vs main navbar
  • SearchBar.tsx: Appropriate search disabling for archive site

Build System - Good

  • prepare-site.mjs: Simple and effective OSS docs fetch bypass
  • New npm scripts (dev:archive, build:archive) provide good DX

Potential Issues & Suggestions

Minor Issues:

  1. docusaurus.config.js:364 - Inconsistent spacing in concatenateModules: false (extra space)
  2. SearchBar.tsx - Consider adding JSDoc comment explaining why search is disabled for archive
  3. Version handling - The hardcoded version arrays work but consider if they could be derived from platform-enterprise_versions.json

Deployment Concerns:

  • Netlify redirects look correct for legacy versions
  • Archive site URL (docs-archive.seqera.io) is properly configured
  • Good separation of tracking (different GTM containers would be ideal)

Security & Performance ✅

  • No security issues identified
  • Good performance optimizations (plugin exclusions for archive)
  • Proper external link handling with rel="noopener noreferrer"
  • Build memory optimizations maintained

Testing & Validation

The validation commands in the PR description are comprehensive:

  • ✅ Archive build: DOCS_SITE_MODE=enterprise-archive ./node_modules/.bin/docusaurus build
  • ✅ Main build: DOCS_SITE_MODE=main EXCLUDE_MULTIQC=true EXCLUDE_WAVE=true ./node_modules/.bin/docusaurus build
  • ✅ Archive dev: DOCS_SITE_MODE=enterprise-archive npm run dev

Final Assessment

This is a solid, production-ready implementation. The code is well-structured, follows good practices, and addresses the requirements effectively. The minor formatting issue is cosmetic.

Recommendation: ✅ APPROVE

The follow-up deployment work mentioned (creating frozen archive branch and Netlify configuration) is correctly identified as post-merge tasks.


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