grafana / killercoda

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

Handle docs/ignore shortcode, removing need for the include directive. #49

Closed jdbaldry closed 3 months ago

jdbaldry commented 3 months ago

Remove the shortcode markers from the parent block and keep the raw Markdown within.

The implementation turned out to be more complicated than expected because the raw Killercoda Markdown within breaks the CommonMark parser (fenced code blocks must end without an action). You can see this also when GitHub tries to render Killercoda Markdown.

This also removes the include directive so we'll need to remove that from the source anywhere it's used.

The linked documentation is being added in https://github.com/grafana/writers-toolkit/pull/770.

Signed-off-by: Jack Baldry jack.baldry@grafana.com

Jayclifford345 commented 3 months ago

Just had a though: If we wanted to keep the new docs syntax but remove the syntax that is breaking pretty

{{exec}}

Could we just make it a requirement to keep using the:

<!-- INTERACTIVE exec START --> 

So then the new syntax would look like this

  {{< docs/ignore >}}
  ### Back to Docs
  Head back to wear you started from to continue with the Loki documentation: [Loki documentation](https://grafana.com/docs/loki/latest/send-data/alloy)
  <!-- INTERACTIVE exec START --> 
     ```bash 
     docker-compose -f loki-fundamentals/docker-compose.yml up -d 
{{< /docs/ignore >}} ``` that way we are still compliant with pretty but also remove the comment syntax for each row?
Jayclifford345 commented 3 months ago

Notes from David: