Azure / simdem

Tool for Simulating Demo's, delivering Tutorials and using documentation as tests.
MIT License
34 stars 17 forks source link

Simdem responds unpredictably to [!INCLUDE] #117

Open jasonmesser7 opened 2 years ago

jasonmesser7 commented 2 years ago

For CLI prerequisites there is an include they use in docs which essentially has all you could ask for. It is [!INCLUDE [azure-cli-prepare-your-environment.md](../../../includes/azure-cli-prepare-your-environment.md)]

This broke Simdem as well with the following error:

image

This one makes sense as it is just looking for the file in SimDem to the include it and fails and so I don’t know if it is a true error. But it is something to think about as the simDem structure won’t match the docs structure and so figuring out where includes go and how to look for stuff may be a problem we need to address.

SorraTheOrc commented 2 years ago

This is an interesting one. I would not have expected it to even be attempting to include the content!

The problem here is docs being written to assume a particular directory structure. If this were an absolute reference to a publicly available fire maybe it would work. But it is impractical to assume this.

SimDem already has the ability to pass execution to another document. The solution here might be to parse the [!include to use the prerequisites feature that does this. This will then allow us to provide a base URL to SimDem on execution (using the public GitHub location of the source file).

This needs some work and experimentation. For now we should manually include the required documents in the test documents being created.