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

[SLO] Add documentation for SLO functionality #147749

Closed
1 of 2 tasks
Tracked by #143216 ...
CoenWarmer opened this issue Dec 19, 2022 · 7 comments · Fixed by #156139
Closed
1 of 2 tasks
Tracked by #143216 ...

[SLO] Add documentation for SLO functionality #147749

CoenWarmer opened this issue Dec 19, 2022 · 7 comments · Fixed by #156139
Assignees
Labels
8.8 candidate Team: Actionable Observability - DEPRECATED For Observability Alerting and SLOs use "Team:obs-ux-management", for AIops "Team:obs-knowledge"

Comments

@CoenWarmer
Copy link
Contributor

CoenWarmer commented Dec 19, 2022

📝 Summary

Part of #143216

If a user has no SLOs configured yet, the user will see a welcome message when visiting the SLO page.

The current designs contains links to a documentation page for SLOs:

Screenshot 2022-12-19 at 10 44 20

The Elastic website should have documentation pages for use of the SLO functionality.

✅ Acceptance criteria

  • Elastic documentation website should have documentation for SLOs: including what they are, how they should be used, creation, editing and deleting functionality.
  • The link in the SLO List Welcome prompt should link to the correct page on the documentation page.
@CoenWarmer CoenWarmer added the Team: Actionable Observability - DEPRECATED For Observability Alerting and SLOs use "Team:obs-ux-management", for AIops "Team:obs-knowledge" label Dec 19, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/actionable-observability (Team: Actionable Observability)

@CoenWarmer CoenWarmer changed the title Add documentation for SLO functionality [SLO] Add documentation for SLO functionality Dec 19, 2022
@kdelemme
Copy link
Contributor

We had a meeting with @mdbirnstiehl and @CoenWarmer yesterday, since we are not going in 8.7, the documentation team will start working on the documentation after they are done with the 8.7 released features.

@kdelemme
Copy link
Contributor

@mdbirnstiehl @ollyhowell I just wanted to let you know the SLO feature is going to be released as beta in 8.8. Let me know if you need any help regarding the documentation.

@kdelemme
Copy link
Contributor

@mdbirnstiehl @ollyhowell Can I help with this?

@mdbirnstiehl
Copy link
Contributor

Hi @kdelemme, we've been wrapping up work on things for the 8.7 release, so we haven't started work on the SLO documentation yet. This will be one of my priorities for 8.8. We are trying a new sprint schedule in Obs Docs where we work on non-release related work for the first 3 weeks after a release. Following that, we will work on release-related, which is where this will fall. You can maybe get a better overview of it from this view of my issues.. But I'm sure I'll need your help at that point and will reach out. Let me know if that makes sense or you have any questions.

@CoenWarmer
Copy link
Contributor Author

@mdbirnstiehl What's the status on this?

@CoenWarmer
Copy link
Contributor Author

Spoke with @mdbirnstiehl over Slack. The URL for docs will be: https://www.elastic.co/guide/en/observability/current/slo.html.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.8 candidate Team: Actionable Observability - DEPRECATED For Observability Alerting and SLOs use "Team:obs-ux-management", for AIops "Team:obs-knowledge"
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants