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.

Sign up for GitHub

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

Jump to bottom

Getting started tutorial #923

Merged
merged 29 commits into from
Jun 12, 2024
Merged

Getting started tutorial #923

merged 29 commits into from
Jun 12, 2024

Conversation

moxious
Copy link
Contributor

@moxious moxious commented May 24, 2024 •
edited
Loading

Objective of this tutorial:

  • Best of my ability, unify the install/configure/restart docs in one place (without copying)
  • Step through & explain the simplest possible pipeline
  • Tell the user that the debug service exists, it's very helpful for learning & experimentation with hot reloading of config & visulization.
  • Try where possible to link in the component reference docs so that they have context and people have "jumping off points" for more advanced config
  • Try to cover both Mac & linux to cast a broad net so one tutorial can work for (most) people.

@moxious moxious added the type/docs Docs Squad label across all Grafana Labs repos label May 24, 2024
@moxious moxious requested a review from clayton-cornell as a code owner May 24, 2024 12:23
clayton-cornell
clayton-cornell reviewed May 24, 2024
View reviewed changes
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions.. more to come later

docs/sources/get-started/install/linux.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
moxious and others added 2 commits May 28, 2024 07:57
clayton-cornell
clayton-cornell reviewed Jun 4, 2024
View reviewed changes
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's quite a few comments now. Can we accept/reject these, and then I will do a local build and continue with the suggestions in the latter half of the tutorial.

docs/sources/get-started/install/linux.md Outdated Show resolved Hide resolved
docs/sources/get-started/install/linux.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
clayton-cornell
clayton-cornell reviewed Jun 4, 2024
View reviewed changes
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
clayton-cornell
clayton-cornell reviewed Jun 7, 2024
View reviewed changes
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some more input and suggestions.

I left the text surrounding enabling the Alloy UI in Linux/macOS alone in this edit pass. I will review again once the current suggestions are accepted/rejected and the content rework around the reload and Alloy UI is completed.

docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
clayton-cornell
clayton-cornell approved these changes Jun 10, 2024
View reviewed changes
Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is looking good enough as-is. One more tweak to the text to tidy up the reference to the CLI arg. Don't need an answer now to the open question about referencing the service restart.

So, once the suggestion is applied I think we can merge this

docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
rfratto
rfratto approved these changes Jun 11, 2024
View reviewed changes
Copy link
Member

@rfratto rfratto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I left a few comments but nothing really blocking.

docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Show resolved Hide resolved
clayton-cornell
clayton-cornell reviewed Jun 11, 2024
View reviewed changes
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
docs/sources/tutorials/get-started.md Outdated Show resolved Hide resolved
moxious and others added 2 commits June 11, 2024 16:54
@clayton-cornell
Copy link
Contributor

Looks good. I'll get this merged now. Any changes/updates we can do in new PRs.

@clayton-cornell clayton-cornell merged commit dbcaf36 into main Jun 12, 2024
21 checks passed
@clayton-cornell clayton-cornell deleted the getting-started-tutorial branch June 12, 2024 17:15
github-actions bot pushed a commit that referenced this pull request Jun 12, 2024
@moxious @grafanabot
Getting started tutorial (#923)
938df5b 
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Robert Fratto <[email protected]>
(cherry picked from commit dbcaf36)
@github-actions github-actions bot mentioned this pull request Jun 12, 2024
Merged
github-actions bot pushed a commit that referenced this pull request Jun 12, 2024
@moxious @grafanabot
Getting started tutorial (#923)
760c5f2 
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Robert Fratto <[email protected]>
(cherry picked from commit dbcaf36)
@github-actions github-actions bot mentioned this pull request Jun 12, 2024
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@clayton-cornell clayton-cornell clayton-cornell approved these changes

@LisaHJung LisaHJung LisaHJung left review comments

@rfratto rfratto rfratto approved these changes

Assignees
No one assigned
Labels
backport release/v1.0 backport release/v1.1 backport-to-agent:no PR should NOT be backported to the agent repo. frozen-due-to-age type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@moxious @clayton-cornell @rfratto @LisaHJung