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.

Sign up for GitHub

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

Jump to bottom

[Observability Onboarding] Fix K8 annotations step #201130

Closed
thomheymann opened this issue Nov 21, 2024 · 3 comments · Fixed by #204260
Closed

[Observability Onboarding] Fix K8 annotations step #201130

thomheymann opened this issue Nov 21, 2024 · 3 comments · Fixed by #204260
Assignees
@gbamparop
Labels
Feature: Observability Onboarding Team:obs-ux-logs Observability Logs User Experience Team

Comments

@thomheymann
Copy link
Contributor

thomheymann commented Nov 21, 2024 •
edited by gbamparop
Loading

📓 Summary

There are a few UX issues in step 3 of the Kubernetes Otel onboarding flow:

Image

The copy to clipboard button should be removed and the instructions need to be broken up into separate paragraphs.

That way there is no ambiguity about what the button does, the instructions are easier to read and we can use the correct syntax highlighter

🎨 Design

Image

✔️ Acceptance Criteria

  • The third step in the onboarding flow will be updated to include two substeps according to the designs:
    • Follow one of the available annotation methods
      • Annotate specific deployments
      • Annotate all resources in the namespace
    • Restart the deployment and verify that the annotations have been applied correctly
@botelastic botelastic bot added the needs-team Issues missing a team label label Nov 21, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-onboarding-team (Feature: Observability Onboarding)

@gbamparop gbamparop added the Team:obs-ux-logs Observability Logs User Experience Team label Nov 28, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-logs-team (Team:obs-ux-logs)

@botelastic botelastic bot removed the needs-team Issues missing a team label label Nov 28, 2024
@gbamparop
Copy link
Contributor

@sileschristian do you think that designs are needed for this one? Should the two code blocks be placed one after the other?

@gbamparop gbamparop mentioned this issue Dec 13, 2024
Merged
@gbamparop gbamparop self-assigned this Dec 13, 2024
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Dec 19, 2024
@gbamparop
Update the annotation step in the OTel Kubernetes flow (elastic#204260)
62170cc 
## 📓 Summary
Updates the third optional step in the OpenTelemetry flow for Kubernetes
according to the latest designs. It splits the guidelines by providing
instructions to annotate specific pods as well as all the resources in
the namespace.

## Before
<img width="1061" alt="image"
src="https://github.com/user-attachments/assets/1c334244-47ea-493d-b8ef-6bf002f97616"
/>

## After
### Amsterdam
<img width="930" alt="image"
src="https://github.com/user-attachments/assets/91bec562-c1dc-4c8c-b58e-d9b71a9d6978"
/>

### Amsterdam (Dark mode)
<img width="931" alt="image"
src="https://github.com/user-attachments/assets/673deb18-588d-4845-9419-3ad00bbae1e2"
/>

### Borealis
<img width="934" alt="image"
src="https://github.com/user-attachments/assets/a79aee17-708a-4809-becc-6a4ba2ffa020"
/>

Closes elastic#201130

---------

Co-authored-by: Elastic Machine <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
(cherry picked from commit 92bc22b)
JoseLuisGJ pushed a commit to JoseLuisGJ/kibana that referenced this issue Dec 19, 2024
@gbamparop @elasticmachine
@mdbirnstiehl @JoseLuisGJ
Update the annotation step in the OTel Kubernetes flow (elastic#204260)
affa730 
## 📓 Summary
Updates the third optional step in the OpenTelemetry flow for Kubernetes
according to the latest designs. It splits the guidelines by providing
instructions to annotate specific pods as well as all the resources in
the namespace.

## Before
<img width="1061" alt="image"
src="https://github.com/user-attachments/assets/1c334244-47ea-493d-b8ef-6bf002f97616"
/>

## After
### Amsterdam
<img width="930" alt="image"
src="https://github.com/user-attachments/assets/91bec562-c1dc-4c8c-b58e-d9b71a9d6978"
/>


### Amsterdam (Dark mode)
<img width="931" alt="image"
src="https://github.com/user-attachments/assets/673deb18-588d-4845-9419-3ad00bbae1e2"
/>

### Borealis
<img width="934" alt="image"
src="https://github.com/user-attachments/assets/a79aee17-708a-4809-becc-6a4ba2ffa020"
/>




Closes elastic#201130

---------

Co-authored-by: Elastic Machine <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gbamparop gbamparop

Labels
Feature: Observability Onboarding Team:obs-ux-logs Observability Logs User Experience Team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update the annotation step in the OTel Kubernetes flow gbamparop/kibana
3 participants
@thomheymann @gbamparop @elasticmachine