Skip to content

Conversation

@josh-wong
Copy link
Member

@josh-wong josh-wong commented Dec 19, 2024

Description

This PR adds the following:

  • A feature to hide unsupported from versions dropdown menu.
  • A single page for navigating to unsupported versions.

As we've continued to release versions of ScalarDB, the version dropdown menu has become long, with most items showing as X.X unsupported. By keeping the version dropdown short, we can continue to release new versions and keep the dropdown menu focused only one the versions that we support.

This feature automatically detects when a version includes (unsupported) or (サポートされていない) in its version label. However, when a version is no longer supported, we need to add that version to /src/pages/unsupported-versions.mdx (English) and i18n/versioned_docs/ja-jp/docusaurus-plugin-content-pages/unsupported-versions.mdx (Japanese) so that visitors can still navigate to that version of docs.

Related issues and/or PRs

N/A

Changes made

  • Implemented a feature that automatically detects when a version is no longer supported:
    • English version of the site: When the version label in docusaurus.config.js includes (unsupported).
    • Japanese version of the site: When the version label in i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-X.X.json includes (サポートされていない).
  • Added a single page for visitors to navigate to unsupported versions of ScalarDB docs.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have updated the side navigation as necessary.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

@josh-wong josh-wong added the enhancement New feature or request label Dec 19, 2024
@josh-wong josh-wong self-assigned this Dec 19, 2024
@netlify
Copy link

netlify bot commented Dec 19, 2024

Deploy Preview for staging-scalardb-docs-site failed. Why did it fail? →

Name Link
🔨 Latest commit b443826
🔍 Latest deploy log https://app.netlify.com/sites/staging-scalardb-docs-site/deploys/6763de28417fee0008470377

@josh-wong josh-wong merged commit fdb2fa2 into main Dec 19, 2024
1 of 5 checks passed
@josh-wong josh-wong deleted the move-unsupported-versions-to-single-page branch December 19, 2024 09:20
josh-wong added a commit that referenced this pull request May 14, 2025
…igating to unsupported versions (#808)

* Swizzle version dropdown component

* Add unsupported versions; remove front-matter config

* Hide unsupported versions from version dropdown menu

* Create unsupported-versions.mdx

* Hide unsupported Japanese versions of docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant