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.
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
first draft of alloy overview rewrite #2031
base: main
Are you sure you want to change the base?
first draft of alloy overview rewrite #2031
Changes from 2 commits
c3ad4bd
58a27d8
d566ee3
1177caf
276cabc
515e175
3e7ce45
7de5261
6f49c90
c149d4f
122640e
48a39ab
a9c7fb6
ecce18a
a34581e
62522e2
8e2ef89
1bec9f0
bdfc6f4
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing to add here is a clear call to action, which is for them to install, configure, and collect forward telemetry data.
We could do that by including the section on getting started in the original draft on the overview page
OR
include a blurb saying, "Getting started with Alloy consists of 3 major steps.
Click here to get started." Then, link it to a new page with content in the original draft as shown below.
New page:
Getting started with Alloy consists of 3 major steps:
In addition, you can use the Grafana dashboard to visualize the data collected from the app or infrastructure.
For a quick overview of this process, check out the following tutorials.
What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some thoughts on this:
Click here
in any documentation.3 major steps
part doesn't fit in so well... if we want to dive into this level of detail, then it should be on a child page.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. @clayton-cornell Why don't we leave out the call to action part and include the suggested text on the Get Started page?
https://grafana.com/docs/alloy/latest/get-started/