/dt_help

DISMTools Help Documentation contents

Primary LanguagePowerShell

DISMTools help documentation

This is the in-progress help documentation content for DISMTools, which will be fully available on a future release.

Contributing, building, and testing

NOTE: be sure to add the Python directory to the PATH environment variable. Python Setup should have an option available. If so, check it

  1. Create your fork of this repo and clone it to your system
  2. Open the docs directory
  3. Open a terminal window in that directory and type mkdocs serve
  4. Go to the IP address shown in the output (for example, localhost:8000)
  5. Create your changes and test
  6. Once you've done your contributions, create a pull request

Building the final site

To build the final sites for all languages, do the following:

  1. Open a terminal window in the directory you have cloned the repo to
  2. Type powershell .\site_gen.ps1

Note

If you see a security warning, you need to unblock the file. To do this:

  • Select the file, go to Properties and click "Unblock"
  • Type in that terminal window the following: powershell -command Unblock-File .\site_gen.ps1

Finally, you'll have all languages in the site folders of all languages.

Additional notes

  • When adding full-window screenshots, ShareX is recommended and must be configured for window transparency capture. Go to the capture settings and enable such option

    NOTE: ShareX must be run as an administrator

  • When adding images to the help content, it's recommended to align it to the center. For that, use this block:

    <p align="center">
    <img src="<path_or_url_to_image>" />
</p>

  • Structure of folders:

    • cli_tools: Location for CLI tools that come with DISMTools
    • getting_started: Location for documentation files to help you get started, including migration from other tools
    • img: Location of the favicon. Do not modify
    • img_tasks: Location of all image tasks
    • res: Location of all resources

  • When creating documentation related to an image task, name it like its respective DISM command. For example, the page for adding AppX packages is called add_provisionedappxpackage.md

Related links