chore: [release-3.1.x] docs: rewrite quickstart with Killercoda metadata #13737
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
Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: J Stickler <julie.stickler@grafana.com> Co-authored-by: Jay Clifford <45856600+Jayclifford345@users.noreply.github.com> (cherry picked from commit 40e8352)
grafanabot
added
backport
size/L
type/docs
JStickler
approved these changes
Aug 1, 2024
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.
Backport 40e8352 from #13234
What this PR does / why we need it:
This allows a tool to parse this source file and regenerate the Killercoda Interactive Learning Environment from its contents.
The documentation becomes a source of truth, and the Killercoda tutorials are automatically updated when this source changes, preventing drift and a poor user experience if things change.
The generated tutorial is https://github.com/grafana/killercoda/tree/staging/loki/loki-quickstart, it's being generated from this branch at the moment.
The documentation for the directives is https://github.com/grafana/killercoda/blob/staging/docs/transformer.md. I'm very happy to write more documentation to help with explaining this to contributors and maintainers.
As I was in the file, I linted it for Writers' Toolkit style.
Special notes for your reviewer:
Please double check the local preview, the directives should not be rendered anywhere in the website page.