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

Add support for tags in docs header #685

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

josh-wong
Copy link
Member

@josh-wong josh-wong commented Feb 5, 2025

Caution

This PR is currently labeled as a draft because we are working on adding the edition tags to ScalarDL docs. After those docs have been updated and added to the docs site, we can merge this PR.

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:

  • applies to a specific edition (Community and/or Enterprise),
  • is an add-on, or
  • is a feature in private or public preview.

Note

Also, since the Helm Charts and Kubernetes docs currently have tags for Enterprise Standard and Enterprise Premium, which are used on the ScalarDB docs site, I created PR #686 that shows those tags as just Enterprise on the ScalarDL docs site and merged that PR into this PR.

Related issues and/or PRs

Changes made

  • Swizzled the DocItem/Footer, DocVersionBadge, and TagsListInline components.
    • Moved tags from the bottom of docs to the top of docs.
  • Added styles for tag button design.
  • Added plugins for Font Awesome icon.
    • The question mark button, which points to the Scalar product pricing page, uses a Font Awesome icon.
  • Enlarged the text in the badge area where the version and tags are.
  • Created PR #686 to make the tags Enterprise Standard and Enterprise Premium, which are in the Markdown front-matter properties in some Helm Charts and Kubernetes docs, appear as Enterprise on the docs site.
    • Merged PR #686 into this PR.

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

Add styles to put tags on the same line as `Version`. Also add styles to make the tags look decent when the dark theme is applied on the docs site.
Make tags more likely to be seen at first glance on a page by adding components here.
Since we want to have tags at the top of the page we should hide them from the footer.
Make `Enterprise Standard` and `Enterprise Premium` tags appear as `Enterprise`.
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