docs: language SDK page updates #2851
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
knylander-grafana
added
the
type/docs
|
@petethepig Do you want me to review? You have it labeled as a WIP but it wasn't marked as a draft. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
@knylander-grafana sorry about the confusion. it was not ready earlier, but it is ready now |
knylander-grafana
requested changes
Dec 15, 2023
There was a problem hiding this comment.
@petethepig Great job updating everything and making sure that things are consistent!
I have some minor changes, but one change I'd like to make across all of the page, which is why this is a change request.
Here's the change (which I'm happy to make and then remove the request changes):
I want to change the Before you begin section acrtoss all of the pages to be only these two paragraphs:
To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or hosted Pryoscope instance with Grafana Cloud Profiles](/products/cloud/profiles-for-continuous-profiling/) (requires a free Grafana Cloud account).
The Pyroscope server can be a local server for development or a remote server for production use.
The rest of the information about Pyroscope and Grafana Cloud Profiles is not necessary for Before you begin. we link to Grafana Cloud Profiles and people can go read if they want to. That extra information feels out of scope for "Before you begin". None of the other doc I work on has that level of detail.
knylander-grafana
approved these changes
Dec 15, 2023
knylander-grafana
added a commit
that referenced
this pull request
Dec 15, 2023
* docs changes * improvements * wip * fixes * fixes * fixes * Update docs/sources/configure-client/language-sdks/go_push.md * Update docs/sources/configure-client/language-sdks/go_push.md * Apply suggestions from code review * Update Before you begin sections --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Kim Nylander <kim.nylander@grafana.com>
knylander-grafana
added a commit
that referenced
this pull request
Dec 16, 2023
* Changes from 2855 intro doc * docs: update go-pull.md (#2844) * docs: update go-pull.md * fix links * rm comments * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * typo * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com> * Create release notes for v1.2.1 (#2860) * docs: Add sampling documentation (#2854) * Add sampling doc * Tweak wording and layout * Fix links * Fix absolute links * Variety of small tweaks in structure and wording * docs: Refactor ebpf installation (#2849) * docs: Refactor ebpf installation * docs: Refactor ebpf installation * Remove not useful sections. * review feedbac * remove absolute link to grafana.com * lint * review feedback * Add diagram for ebpf * linted * Update docs/sources/configure-client/grafana-agent/ebpf/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/configuration/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/configuration/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-docker.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-docker.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-kubernetes.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-kubernetes.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-kubernetes.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com> * docs: language SDK page updates (#2851) * docs changes * improvements * wip * fixes * fixes * fixes * Update docs/sources/configure-client/language-sdks/go_push.md * Update docs/sources/configure-client/language-sdks/go_push.md * Apply suggestions from code review * Update Before you begin sections --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Kim Nylander <kim.nylander@grafana.com> * doc: Add sampling diagram (#2861) --------- Co-authored-by: Tolya Korniltsev <korniltsev.anatoly@gmail.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com> Co-authored-by: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com> Co-authored-by: Cyril Tovena <cyril.tovena@gmail.com> Co-authored-by: Dmitry Filimonov <dmitry.filimonov@grafana.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
addresses this #2775
Fixes: #2775