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

[outreachy] updated registry with inline help tooltips #5450

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bhekidaweti
Copy link

This PR resolves #5420. I implemented hover hints on key action buttons to make clear to users what they can expect when they click these buttons. The buttons show users exactly how to interact with different parts of the OpenTelemetry registry.

I also added a hover hint on the alert text that describes what OpenTelemetry Registry is, further describing what the Telemetry is, without leaving the page itself.

Example of the hover hint in one of the action buttons.

programming-language-hint

Hover hint in the alert description

oTel-hint

@bhekidaweti bhekidaweti requested a review from a team as a code owner October 21, 2024 16:01
@bhekidaweti
Copy link
Author

Hello, @svrnm I have made another PR with the changes and the correct files to work on as per our last discussion.

@svrnm svrnm changed the title updated registry with inline help tooltips [outreachy] updated registry with inline help tooltips Oct 21, 2024
@svrnm svrnm added the outreachy Issues for Outreachy Participants label Oct 21, 2024
@@ -34,10 +34,54 @@
{{ end -}}
{{ $types = $types | uniq | sort -}}

<!--Custom css for the inline help-->
Copy link
Member

Choose a reason for hiding this comment

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

Please move custom CSS into this file:

https://github.com/open-telemetry/opentelemetry.io/blob/main/assets/scss/_registry.scss

Doing so, make sure that the CSS is only applied on that page, e.g. right now if we use "btn-outline-success" class on any other page the hover::after would also be applied

Copy link
Author

Choose a reason for hiding this comment

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

Thanks mentor I will update it.

Copy link
Member

Choose a reason for hiding this comment

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

Please make sure that you provide the update today, such that I still can review it. I will not be available for more feedback afterwards until the end of the application phase

Copy link
Member

@svrnm svrnm left a comment

Choose a reason for hiding this comment

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

minor comment, otherwise lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
outreachy Issues for Outreachy Participants
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

[outreachy] Registry: inline help
2 participants