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

💡 [REQUEST] - Add end-to-end quickstart to README.md for new users #318

Open
1 task done
lvaylet opened this issue Jan 20, 2023 · 0 comments
Open
1 task done
Assignees
Labels
question Further information is requested

Comments

@lvaylet
Copy link
Collaborator

lvaylet commented Jan 20, 2023

Summary

At the time of writing, README.md has an installation and basic usage section, but no actual end-to-end example based on a simple application or service actually running on GCP.

Can we add such an example so new users can run the commands and experiment first-hand what the SLO Generator does?

Basic Example

Add an example over a simple service running in Cloud Run, deployed from an image available on a public registry. For example an application that fails on purpose 20% of the time. Then define an SLO with a 95% target over 28 days and confirm the output shows up as expected with alerts.

Screenshots

![DESCRIPTION](LINK.png)

Drawbacks

None identified. This will help new users onboard faster.

Unresolved questions

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@lvaylet lvaylet added the question Further information is requested label Jan 20, 2023
@lvaylet lvaylet self-assigned this Jan 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant