Docs tidy up - clarify, fix typos and fix formatting #1250
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The New-LabDefinition function does not have a -Path parameter.
The New-LabSourcesFolder function uses a -DriveLetter parameter. While using -Drive will work, it would be best to clarify the correct parameter.
|
Thanks you, @pauby! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is my first time using AutomatedLab, so I was going through the docs from the start to the end and noticed some things that are incorrect, some typos and formatting errors I wanted to fix.
There are a number of commits in this PR as I did them as I went along. I'm happy to squash and force push if that would make it easier. However, this commit and this one have a fuller description of why I made the changes that would be useful to have for context.
Please describe your changes in detail, unless the title is already descriptive enough.
Type of change
How was the change tested?
The only changes that needed testing were the formatting ones - to make sure they worked. I tested this using the markdown preview in VS Code. Although to be fair, the doc rendered properly before my changes in VS Code. So, I'm assuming the process to get it to ReadTheDocs is messing things up OR ReadTheDocs is stricter than VS Code. Regardless, it renders as it should.