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 <jack.baldry@grafana.com>
@jdbaldry jdbaldry force-pushed the 2024-06-killercoda-migration branch from bf4a866 to 163c9b4 Compare June 17, 2024 14:31
@jdbaldry
Demonstrate with regexps
1d44bf1 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Start rendering Markdown from Markdown
668b21c 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Remove between ignore markers
fbd3bd0 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Add intro transformer
df204a9 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Add exec and copy transformations
bc5b88e 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Transform localhost and partial URLs
2b4501e 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Consolidate action transformers
8da17aa 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Replace figure shortcodes with images
ce27fcb 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry jdbaldry marked this pull request as ready for review June 19, 2024 04:17
@jdbaldry
Ensure heading hierarchy starts with H1
5bb7252 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry jdbaldry changed the title Start generation Generate Loki Quickstart tutorial from documentation source Jun 19, 2024
@jdbaldry
Remove vendored Goldmark HTML renderer implementation
f9e7d54 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@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 <jack.baldry@grafana.com>
@jdbaldry
Include path
7443ce9 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Update generated tutorial
9f6fa8a 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@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 <jack.baldry@grafana.com>
@jdbaldry
Add include directive
c32009f 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Regenerate with include directive support
a6e8809 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Add exec action
48d70d0 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Jayclifford345 and others added 9 commits June 19, 2024 11:28
@Jayclifford345
remove indentation to try and fix markdown issue
e054d32
@Jayclifford345
Copy paste reformat
38c69d0
@Jayclifford345
added missng bash and indented code blocks
6a46b65
@Jayclifford345
Testing supports fix
273c8c5
@jdbaldry
Add action directive to all inline code
033aeef 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Regenerate
71756fd 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Cleanup
4c4084d 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Add command line argument handling
341bdea 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Add workflow to regenerate tutorials
72660e5 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@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 <jack.baldry@grafana.com>
@jdbaldry
Fix checkout
28bc61e 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Fix path to go.mod
6c396ea 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Fix repository quoting
7c6e186 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Fix typo
2119fcf 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Fix working directory for build
d5dafab 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Fix path to transformer binary
8251754 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Make script executable
29efb1b 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Lint
9b33063 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Add GITHUB_TOKEN environment variable
718f288 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Fill in the subject
f03fce5 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Ignore transformer binary
bd68bc7 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Use empty body
a99b4bd 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Write index.json and intro file if present
a7e73c8 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Add preprocessing substitution step
5ad8c79 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@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 <jack.baldry@grafana.com>
@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