New Video: Getting Started with your Documentation Tools

New Video: Getting Started with your Documentation Tools

To make it easier than ever to make both small and larger contributions to the DataMiner documentation, we have now recorded a second video on editing the DataMiner docs. This time, we explain step by step how to set up the documentation tools that allow you to comfortably make larger contributions. This includes GitHub Desktop, Visual Studio Code, and DocFX.

Why should you opt for Visual Studio Code instead of another method?

  • Team Documentation at Skyline Communications are experts at Visual Studio Code and are always ready to help when something goes wrong on your end.
  • Visual Studio Code offers the implementation of useful extensions, e.g. a spell check, a Markdown linter, etc.
  • Problems in your Markdown are automatically highlighted in Visual Studio Code. Because of this feature, you are a lot less likely to read over your own mistakes.
  • With this setup, you can run a test build on your local machine. This is especially handy when you have added and/or removed pages, have added cross-references, etc.

Convinced? Watch our new video on how to successfully install not only Visual Studio Code, but GitHub Desktop and DocFX as well.

This is the second video in our series on how to contribute to the DataMiner docs. In the next video, we will help you locate pages in the DataMiner docs repository on Visual Studio Code, show you how to create and work in your own branch, how to create a larger contribution, and how to make a pull request.

Don’t want to wait until then? Check out Making a larger contribution.

Missed the first video on making a small contribution to the DataMiner docs? You can find it here.

1 thought on “New Video: Getting Started with your Documentation Tools

Leave a Reply