search

grafana / killercoda

This repository holds tutorials designed and hosted on Killercoda and interactive education platform.
https://killercoda.com/
Apache License 2.0
2 stars 4 forks source link

bug: How to deal with {{<code>}} blocks #28

Open Jayclifford345 opened 1 week ago

Jayclifford345 commented 1 week ago

Notice how I mis-copy/pasted and I "end a block" before it started. Below this block, I end it a second time. No warnings either time, no step5 emitted by the transformer. Ideally, the code would say "hey dude you ended something before you started it" and fail.

Jayclifford345 commented 1 week ago

Options:

  1. Do we omit only code block tagged automatically with a macos or windows tag?
  2. Do we actively ask users to put them entire code block in ignore tags and write a separate killercoda include
jdbaldry commented 1 week ago

So the code shortcode can be used for more than just different distributions. It can also be different languages for SDK documentation or something like that.

Ideally, I think all options should be present in the Killercoda tutorial but presenting that information may be challenging. Perhaps there should also be a mechanism to suppress specific blocks like macos that won't ever work in the ILE.

Maybe Killercoda have their own implementation of tabbed snippets? I don't see anything like a Markdown reference on their site though.