Add support for tags in docs header #469
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since we want to have tags at the top of the page we should hide them from the footer.
Make tags more likely to be seen at first glance on a page by adding components here.
Add styles to make tags on the same line as `Version` and provide styles to make it look decent in the dark theme.
Add Font Awesome components and question-mark icon. The question-mark icon links to our pricing page, which shows features for the available editions.
These styles are no longer necessary after swizzling the `TagsListInline` component and changing `Tags` to `Editions`.
If `Edition` is right aligned, the spacing is awkward if the screen becomes narrow on both desktop and mobile. In such case, at least for now, aligning the `Edition` tags below the version number is less awkward.
Change component name, which was changed in Docusaurus 3.5.0.
Since we'll be showing tags other than editions, we've decided to remove "Editions" from the badge area at the top of the page.
✅ Deploy Preview for staging-scalardb-enterprise-doc-reorg ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
josh-wong
changed the title
6 tasks
6 tasks
josh-wong
added a commit
that referenced
this pull request
Sep 18, 2024
This announcement is to notify visitors that the docs for both ScalarDB Community and Enterprise editions are available on this docs site. The editions are displayed as tags, which is implemented in #469.
6 tasks
josh-wong
added a commit
that referenced
this pull request
Sep 24, 2024
…Enterprise docs (#595) * Create index.tsx * Comment out tags in footer Since we want to have tags at the top of the page we should hide them from the footer. * Create index.tsx * Add tags to top of page Make tags more likely to be seen at first glance on a page by adding components here. * Add styles for tags at top of page Add styles to make tags on the same line as `Version` and provide styles to make it look decent in the dark theme. * Change tag header from `Tags:` to `Editions:` * Add Font Awesome plugins * Add styles for Font Awesome question-mark icon * Add Font Awesome components and question-mark icon Add Font Awesome components and question-mark icon. The question-mark icon links to our pricing page, which shows features for the available editions. * Add tooltip for question-mark button/link * Add tooltip style and border to tags on hover * Create styles.module.css * Create index.tsx * Remove unnecessary styles These styles are no longer necessary after swizzling the `TagsListInline` component and changing `Tags` to `Editions`. * Make `Edition` left-aligned If `Edition` is right aligned, the spacing is awkward if the screen becomes narrow on both desktop and mobile. In such case, at least for now, aligning the `Edition` tags below the version number is less awkward. * Change component name Change component name, which was changed in Docusaurus 3.5.0. * Justify align tags with version * Comment out "Editions" Since we'll be showing tags other than editions, we've decided to remove "Editions" from the badge area at the top of the page. * Add tags * Add tags * Remove awkward margin spacing on mobile * Add announcement about unified docs for editions This announcement is to notify visitors that the docs for both ScalarDB Community and Enterprise editions are available on this docs site. The editions are displayed as tags, which is implemented in #469. * Fix styling for announcement bar The close button in the announcement bar was too low and aligned in the middle of the banner. * Fix issue with tags being left aligned in Firefox * Fix collapse button background for Firefox * Revert "Merge branch 'add-support-for-tags-in-doc-header' into announcement/add-notice-about-community-and-enterprise-docs-site" This reverts commit 71f4978, reversing changes made to b14409d. * Revert "Merge branch 'add-support-for-tags-in-doc-header' into announcement/add-notice-about-community-and-enterprise-docs-site" This reverts commit ffd9945, reversing changes made to a4ae874. * Revise message in announcement banner
6 tasks
josh-wong
added a commit
that referenced
this pull request
May 14, 2025
* Create index.tsx * Comment out tags in footer Since we want to have tags at the top of the page we should hide them from the footer. * Create index.tsx * Add tags to top of page Make tags more likely to be seen at first glance on a page by adding components here. * Add styles for tags at top of page Add styles to make tags on the same line as `Version` and provide styles to make it look decent in the dark theme. * Change tag header from `Tags:` to `Editions:` * Add Font Awesome plugins * Add styles for Font Awesome question-mark icon * Add Font Awesome components and question-mark icon Add Font Awesome components and question-mark icon. The question-mark icon links to our pricing page, which shows features for the available editions. * Add tooltip for question-mark button/link * Add tooltip style and border to tags on hover * Create styles.module.css * Create index.tsx * Remove unnecessary styles These styles are no longer necessary after swizzling the `TagsListInline` component and changing `Tags` to `Editions`. * Make `Edition` left-aligned If `Edition` is right aligned, the spacing is awkward if the screen becomes narrow on both desktop and mobile. In such case, at least for now, aligning the `Edition` tags below the version number is less awkward. * Change component name Change component name, which was changed in Docusaurus 3.5.0. * Justify align tags with version * Comment out "Editions" Since we'll be showing tags other than editions, we've decided to remove "Editions" from the badge area at the top of the page. * Add tags * Add tags * Remove awkward margin spacing on mobile * Fix issue with tags being left aligned in Firefox
josh-wong
added a commit
that referenced
this pull request
May 14, 2025
…Enterprise docs (#595) * Create index.tsx * Comment out tags in footer Since we want to have tags at the top of the page we should hide them from the footer. * Create index.tsx * Add tags to top of page Make tags more likely to be seen at first glance on a page by adding components here. * Add styles for tags at top of page Add styles to make tags on the same line as `Version` and provide styles to make it look decent in the dark theme. * Change tag header from `Tags:` to `Editions:` * Add Font Awesome plugins * Add styles for Font Awesome question-mark icon * Add Font Awesome components and question-mark icon Add Font Awesome components and question-mark icon. The question-mark icon links to our pricing page, which shows features for the available editions. * Add tooltip for question-mark button/link * Add tooltip style and border to tags on hover * Create styles.module.css * Create index.tsx * Remove unnecessary styles These styles are no longer necessary after swizzling the `TagsListInline` component and changing `Tags` to `Editions`. * Make `Edition` left-aligned If `Edition` is right aligned, the spacing is awkward if the screen becomes narrow on both desktop and mobile. In such case, at least for now, aligning the `Edition` tags below the version number is less awkward. * Change component name Change component name, which was changed in Docusaurus 3.5.0. * Justify align tags with version * Comment out "Editions" Since we'll be showing tags other than editions, we've decided to remove "Editions" from the badge area at the top of the page. * Add tags * Add tags * Remove awkward margin spacing on mobile * Add announcement about unified docs for editions This announcement is to notify visitors that the docs for both ScalarDB Community and Enterprise editions are available on this docs site. The editions are displayed as tags, which is implemented in #469. * Fix styling for announcement bar The close button in the announcement bar was too low and aligned in the middle of the banner. * Fix issue with tags being left aligned in Firefox * Fix collapse button background for Firefox * Revert "Merge branch 'add-support-for-tags-in-doc-header' into announcement/add-notice-about-community-and-enterprise-docs-site" This reverts commit 71f4978, reversing changes made to b14409d. * Revert "Merge branch 'add-support-for-tags-in-doc-header' into announcement/add-notice-about-community-and-enterprise-docs-site" This reverts commit ffd9945, reversing changes made to a4ae874. * Revise message in announcement banner
josh-wong
added a commit
that referenced
this pull request
Oct 7, 2025
The Community docs are present in the main ScalarDB docs site based on tag (#469), so this note is no longer needed
josh-wong
added a commit
that referenced
this pull request
Oct 7, 2025
The Community docs are present in the main ScalarDB docs site based on tag (#469), so this note is no longer needed
6 tasks
josh-wong
added a commit
that referenced
this pull request
Oct 7, 2025
* Remove note about Community docs being elsewhere The Community docs are present in the main ScalarDB docs site based on tag (#469), so this note is no longer needed * Apply suggestion from Gemini
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds support for tags in the docs header below the title. These tags are shown so that readers can see if the doc they are reading:
This PR effectively turns what was previously the ScalarDB Enterprise docs site into the ScalarDB docs site, which includes docs for both Community and Enterprise editions.
Related issues and/or PRs
Changes made
DocItem/Footer,DocVersionBadge, andTagsListInlinecomponents.Checklist
N/AN/AN/AAdditional notes (optional)
N/A