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

[release/v1.10] docs: Getting started demo + sandbox #3687

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

github-actions[bot]
Copy link
Contributor

Backport f539340 from #3584


I have added a getting-started demo based on the ride-share app. This takes users through the basics of using Pyroscope to identify a bottleneck within the application code provided. This tutorial also provides a interactive sandbox for the user to try out this demo: https://killercoda.com/grafana-dev-testing/course/pyroscope/ride-share-tutorial

Unfortunately, there is an unusual bug within the Profile Explorer app (when using the sandbox) for which I am seeing help. For now, I have tagged this within the sandbox and once fixed will remove the notice. The rest of the sandbox which uses the Pyroscope UI works great! There is also a grafana play link so they can try this there

{{<docs/ignore>}}
{{< admonition type="tip" >}}
Unfortunately, due to a bug within the Sandbox environment, the profile explorer app is currently unavailable. We are working on a fix and will update this tutorial once resolved. If you would like to try out the profile explorer app, you can run the example locally on your machine. Or you can try out this example in [Grafana Play](https://play.grafana.org/a/grafana-pyroscope-app/profiles-explorer?searchText=&panelType=time-series&layout=grid&hideNoData=off&explorationType=labels&var-serviceName=pyroscope-rideshare-python&var-profileMetricId=process_cpu:cpu:nanoseconds:cpu:nanoseconds&var-dataSource=grafanacloud-profiles&var-groupBy=all&var-filters=)
{{< /admonition >}}
{{</docs/ignore>}}

I belive for now the rest of the demo is good enough to get out there. Many thanks in advance for the review!

* Added getting started tutorial

* added temp notice to sandbox

* added play link

* fixed typo

* fixed typos

* Update docs/sources/get-started/ride-share-tutorial.md

---------

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
(cherry picked from commit f539340)
@github-actions github-actions bot requested review from a team as code owners November 14, 2024 17:56
@github-actions github-actions bot added backport type/docs Improvements for doc docs. Used by Docs team for project management labels Nov 14, 2024
@knylander-grafana knylander-grafana merged commit 63e4765 into release/v1.10 Nov 14, 2024
1 check passed
@knylander-grafana knylander-grafana deleted the backport-3584-to-release/v1.10 branch November 14, 2024 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport type/docs Improvements for doc docs. Used by Docs team for project management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants