-
Notifications
You must be signed in to change notification settings - Fork 1
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 glossary tooltip feature #681
Draft
josh-wong
wants to merge
17
commits into
main
Choose a base branch
from
add-definition-tooltip-feature
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains 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
Swizzle component to add glossary tooltip function.
Ignore `/static/glossary.json` since we only need it when building the site in production.
josh-wong
changed the title
Add definition tooltip feature
Add glossary tooltip feature
Oct 29, 2024
josh-wong
force-pushed
the
add-definition-tooltip-feature
branch
from
October 29, 2024 06:07
d6232ee
to
aa56164
Compare
✅ Deploy Preview for staging-scalardb-docs-site canceled.
|
On desktop: Increase padding around definitions. On mobile: Add styles to keep the tooltip within view on narrow screens.
To avoid confusion with the glossary tooltip, this commit clarifies the naming for the tooltip for the question mark icon in the header that contains version and edition tags.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Caution
This PR should not be merged until after the English glossary and Japanese glossary for 3.13 and 3.14 (latest) are published.
Description
This PR adds a tooltip feature that shows the definition of terms from our glossary.
The tooltip appears on only the first mention within the content of the doc, whether it's in a paragraph, ordered or unordered list, or table. The tooltip doesn't appear in headings, links, or code blocks.
In addition, the tooltip shows English definitions on English pages and Japanese definitions on Japanese pages.
Note
The glossary tooltip feature appears only in production environments.
Related issues and/or PRs
Changes made
glossary.mdx
docs in the folder for the latest release.Checklist
N/A
N/A
Additional notes (optional)
N/A