Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Versioned Docs #11290

Merged
merged 35 commits into from
Oct 8, 2024
Merged

Versioned Docs #11290

merged 35 commits into from
Oct 8, 2024

Conversation

chargome
Copy link
Member

@chargome chargome commented Sep 9, 2024

closes #3881

This PR introduces versioned documentation for docs.sentry.io

Features

  • Versioned files
  • Versioned platform includes
  • Warning banner
  • Update metadata for versioned files
  • Check for versioning in developer docs
  • Version index files
  • Version top level guides
  • Make redirects links
  • (nice to have) redirect non-existing versioned pages on the server if a unversioned variant exists
  • (OPTIONAL) Exclude versioned files from static build

🐛 Known bugs

  • Version selector does not update on soft navigation
  • Versions are displayed on sidebar
  • Versioned pages do not include other versions
  • Original page should be highlighted in sidebar when versioned page is selected
  • Wrong color in version selector in dark mode

Cleanup

  • Remove versioned demo pages

NOTE: In the current state, versioned platform-redirects can only be displayed if their containing root page is also versioned

NOTE FOR REVIEWERS:

Maybe read the contributing entry that is included in this pr first.

You can inspect a versioned file by browsing these paths on the preview url:
/platforms/javascript/guides/nextjs/manual-setup/ (scoped to Next.js)
/platforms/javascript/guides/nextjs/usage/ (scoped to JavaScript)
/platforms/javascript/guides/express/ (scoped to Express - this one also uses versioned platform includes)

@chargome chargome self-assigned this Sep 9, 2024
Copy link

vercel bot commented Sep 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 1:39pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 1:39pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Oct 8, 2024 1:39pm

Copy link

codecov bot commented Sep 9, 2024

Bundle Report

Changes will increase total bundle size by 170.11kB (1.2%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 7.61MB 160.8kB (2.16%) ⬆️
sentry-docs-edge-server-array-push 257.07kB 3 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 6.43MB 9.31kB (0.15%) ⬆️

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

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

Nice! This is a great 🚢!

docs/contributing/platforms/versioning.mdx Show resolved Hide resolved
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Versioned Docs
4 participants