Feature Request: Initialization Script

[mqasimsarfraz]

Currently, if we want to test a markdown block that depends on certain dependencies e.g. installing krew, we have to perform these steps either via Makefile or as additional step in CI.

It would be great if we have a way to specify an initialization script for a document (similar to how we can specify custom vars) to be able to handle dependencies in consistent way.

[mayasingh17]

Hi @mbifeld wanted to provide some context on this issue. We (Inspektor Gadget) would love to integrate Innovation Engine into our CI pipeline to test our upstream documentation. However, it requires an initialization script so that we can test a number of blocks of code in which we provide documentation around running the gadgets (but don't include the installation steps for IG in every single example), in this case an Initialization script would be very helpful to stand up the infrastructure needed to then test the many commands related to actually running the gadgets.

[rgardler-msft]

@mayasingh17 can you please take a look at the approach taken in https://github.com/Azure/InnovationEngine/blob/main/examples/KubeRay/deploy-kuberay.md - specifically at what we are doing in the "Prerequisites" section of that example document. Is this the same use case you are describing?

If so, then this will be resolved when we add support for prerequisites which we have committed to (no ETA at this point). Once that is complete it will be possible to reference external files that have this kind of content. Such pre-reqs will be sharable across different documents.

You can track progress on this work via #236