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

docs: Getting started rewrite #16497

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Conversation

Jayclifford345
Copy link
Contributor

@Jayclifford345 Jayclifford345 commented Feb 28, 2025

What this PR does / why we need it:
With the focus change to two deployment modes, Monolthic and Microservice, it was time to refresh the quick start guide to Loki. This incorporates much of the same flavour as the original:

  • Docker logs scraping
  • LogQL examples
  • Datasource setup

But includes newer features:

  • Grafana Logs Drilldown
  • Alloy Live debugging

Aswell as adding the Carnivouse Greehouse example to provide an interactive method to understanding LogQL queries.

Killercoda sample found here: https://killercoda.com/grafana-dev-testing/course/workshops/course-tracker-test

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@Jayclifford345 Jayclifford345 requested a review from a team as a code owner February 28, 2025 10:30
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Feb 28, 2025
Copy link
Contributor

github-actions bot commented Feb 28, 2025

💻 Deploy preview available:

@Jayclifford345 Jayclifford345 requested a review from JStickler March 3, 2025 12:11
@Jayclifford345
Copy link
Contributor Author

@JStickler, for some reason, the tests keep failing on this one. We are ready for review, happy to discuss these changes on our call together as it was quite a big change to the getting started guide.

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

Only made it through the docs before I ran out of time. I'll look at the KillerCoda tomorrow.

@Jayclifford345
Copy link
Contributor Author

Aaah thanks @JStickler! All changes are accepted, and the killercoda has been updated for your testing.

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

Made it through both the docs/local install and the Killercoda today.

Jayclifford345 and others added 2 commits March 12, 2025 14:33
Co-authored-by: J Stickler <[email protected]>
Signed-off-by: Jay Clifford <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Signed-off-by: Jay Clifford <[email protected]>
@Jayclifford345
Copy link
Contributor Author

Hey @JStickler, just accepted your amendments. Will work through the rest manually :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XL type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants