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

docs: enable tooltips #21324

Closed
wants to merge 1 commit into from

Conversation

dgarcia360
Copy link
Contributor

Related issue #873

Updates the docs theme to the latest version to enable tooltips and modifies the db_options.tmpl to show the new role in action.

How to test

  1. Clone this PR.

  2. Build the docs.

  3. Open http://127.0.0.1:5500/reference/configuration-parameters/ and preview the tooltips:

    image

Updates the theme to the latest version to enable tooltips and modifies the db_options.tmpl to show the new role in action.
@scylladb-promoter
Copy link
Contributor

Docs Preview 📖

Docs Preview for this pull request is available here

Changed Files:

Note: This preview will be available for 30 days and will be automatically deleted after that period. You can manually trigger a new build by committing changes.

@annastuchlik annastuchlik added documentation Requires documentation backport/none Backport is not required labels Oct 28, 2024
Copy link
Collaborator

@annastuchlik annastuchlik left a comment

Choose a reason for hiding this comment

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

Looks great.

@annastuchlik annastuchlik added the status/merge candidate Item needs maintainer attention label Oct 28, 2024
@annastuchlik
Copy link
Collaborator

@tzach Please have a look.

@tzach
Copy link
Contributor

tzach commented Oct 29, 2024

I love the tooltip feature, but in this case (Liveness) the tip is too long, and hard to read.
Maybe less text, bigger font, will help

@annastuchlik
Copy link
Collaborator

I love the tooltip feature, but in this case (Liveness) the tip is too long, and hard to read. Maybe less text, bigger font, will help

@tzach We're on the same page here. Tooltips that are too long are hard to follow, and we should avoid lengthy descriptions. This PR only demonstrates how the tooltip feature works — we need to adjust the tooltip content while using the feature.

Regarding the bigger font, we need to see how it would work. Perhaps increasing spacing would do?
Thanks for your feedback. We'll address it in a follow-up PR.

@annastuchlik
Copy link
Collaborator

@denesb Please merge.

@@ -0,0 +1,1374 @@
# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand.

Copy link
Member

Choose a reason for hiding this comment

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

Is this part of the commit or accidental?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's part of the commit (update to the latest version). We now include poetry.lock in all projects (context).

Unless contributors manually run make update, the poetry.lock file will remain static and won’t be changed in other pull requests.

Copy link
Contributor

Choose a reason for hiding this comment

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

In the future, consider doing this as a separate PR or at least as a separate commit, so it doesn't get lost in the noise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/none Backport is not required documentation Requires documentation promoted-to-master status/merge candidate Item needs maintainer attention
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants