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

Generate Loki Quickstart tutorial from documentation source #6

Closed
wants to merge 45 commits into from
Closed

Generate Loki Quickstart tutorial from documentation source #6

wants to merge 45 commits into from

Conversation

jdbaldry
Copy link
Member

@jdbaldry jdbaldry commented Jun 17, 2024 •
edited
Loading

Uses the source in grafana/loki#13234 to generate the Killercoda tutorial

TODO:

  • Add workflow for regeneration
  • Support generating multiple tutorials
  • Test with other tutorials
  • Features
    • Link transformer
      • Version substitution
      • hostname
      • localhost special case
    • Heading fixer (ensure proper heading hierarchy)
    • Shortcode transformer
      • figure
      • note
    • Directives
      • Introduction
      • Ignore
      • Execute
      • Copy
      • Finish

@jdbaldry jdbaldry force-pushed the 2024-06-killercoda-migration branch 2 times, most recently from 01904d0 to bf4a866 Compare June 17, 2024 14:22
@jdbaldry
Start generation
163c9b4 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry force-pushed the 2024-06-killercoda-migration branch from bf4a866 to 163c9b4 Compare June 17, 2024 14:31
@jdbaldry jdbaldry marked this pull request as ready for review June 19, 2024 04:17
@jdbaldry jdbaldry changed the title Start generation Generate Loki Quickstart tutorial from documentation source Jun 19, 2024
@jdbaldry jdbaldry force-pushed the 2024-06-killercoda-migration branch from 205db75 to f9e7d54 Compare June 19, 2024 05:27
@jdbaldry
Lint
2e91509 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Include path
7443ce9 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Update generated tutorial
9f6fa8a 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Simplify and make ignore transformer more efficient
a0d9835 
Process children before leaving the parent node rather than reprocessing siblings.

Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Add include directive
c32009f 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Regenerate with include directive support
a6e8809 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Add exec action
48d70d0 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry mentioned this pull request Jun 20, 2024
Merged
@jdbaldry
Merge remote-tracking branch 'origin/main' into jdb/2024-06-killercod…
a40daae 
…a-migration
@jdbaldry
Reuse blank workflow for testing
3219c62 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Fix checkout
28bc61e 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Fix path to go.mod
6c396ea 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Fix repository quoting
7c6e186 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Fix typo
2119fcf 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Fix working directory for build
d5dafab 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Fix path to transformer binary
8251754 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Make script executable
29efb1b 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Lint
9b33063 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Add GITHUB_TOKEN environment variable
718f288 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Fill in the subject
f03fce5 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Ignore transformer binary
bd68bc7 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Use empty body
a99b4bd 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Write index.json and intro file if present
a7e73c8 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry
Add preprocessing substitution step
5ad8c79 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry force-pushed the 2024-06-killercoda-migration branch from 5106fee to 5ad8c79 Compare June 20, 2024 13:33
@jdbaldry
Regenerate
c11e350 
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry closed this Jun 21, 2024
@jdbaldry jdbaldry deleted the 2024-06-killercoda-migration branch June 21, 2024 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Jayclifford345 Jayclifford345 Jayclifford345 left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jdbaldry @Jayclifford345