Skip to content
Dynamic Telemetry is a PROPOSAL : please provide feedback! :-)

Dynamic Telemetry is not an implementation, it's a request for collaboration, that will lead to an shared understanding, and hopefully one or more implementations.

Your feedback and suggestions on this document are highly encouraged!

Please:

  1. Join us, by providing comments or feedback, in our Discussions page

  2. Submit a PR with changes to this file ( docs/README.EDITING.CONTAINER.md)

Direct Sharing URL

http://microsoft.github.io/DynamicTelemetry/docs/README.EDITING.CONTAINER/

Using the Markdown editing container

MkDocs is our markdown rendering in Dynamic Telemetry, providing a pleasant looking markdown-to-HTML converter that integrates well with GitHub.

Because MkDocs depends on Python, versioning issues can arise. To avoid these complications, a single Docker or Podman container is used, bundling MkDocs, Python, and all required tools.

Using the container is straightforward, involving two steps - one of which is a one-time setup.

Installation

  1. Install Docker or Podman from https://www.docker.com

  2. From the tools directory in DynamicTelemetry, build the container using:

    docker build -f
      Dockerfile.mkdocs -t "dynamictelemetry/dynamictelemetry:mkdocs" .

  3. Once the build process is complete, simply use the container. In a workflow that looks something like this.

  4. In a Stand alone. terminal window, use 'docker compose up' command. which will monitor Profile changes and update accordingly.

    docker compose up