Skip to content

Commit

Permalink
Helping tidy the documentation in contributing.mb and createnewlab.md (
Browse files Browse the repository at this point in the history
…#1287)

helping tidy the documentation
  • Loading branch information
BenHollamby committed Feb 18, 2022
1 parent 92898d0 commit 21f9fe5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ Your help is greatly appreciated! This project, as all other open-source project
There are a couple of ways you can help us out.
* [Issues](#Issues): The easiest way to contribute is to identify that something is broken or that a feature is missing and create an issue from it. Even better would be fixing an open issue that has no assignee yet. You can of course do both - find something that is missing and fix it yourself!
* [Reviews](#Reviews): With more contributions coming in we will likely see more pull requests. Reviewing them is not always the most fun, but it is very necessary and would help a lot.
* [Documentation](#Documentation): Documentation is probably most people's least favorite item on the agend. However, we need good docs. If you have a great scenario you would like to document, or if you would like to update an existing document, this would be awesome.
* [Documentation](#Documentation): Documentation is probably most people's least favorite item on the agenda. However, we need good docs. If you have a great scenario you would like to document, or if you would like to update an existing document, this would be awesome.

## Issues
### Standard issues
Opening issues is very easy. Head to our [Issues tab](https://github.com/automatedlab/automatedlab/issues) and open one if it does not exist already. If an issue exists that might have something to do with yours, e.g. is the basis for something your are requesting, please link this issue to yours.
### Bugs, errors and catastrophies
If you encounter an error during a lab setup, there are some basic details we need to be able to help you.
1. The script you used. Feel free to strip out any incriminating details, but it must be able to be executed
1. The script you used. Feel free to strip out any incriminating details, but it must be able to be executed.
2. The verbose and error output of the script! Either set `$VerbosePreference = 'Continue'` or use the verbose switch for Install-Lab.
1. If possible, the result of `New-PSFSupportPackage -Include All`
1. If possible, the result of `New-PSFSupportPackage -Include All`.
### Fixing an issue
Fixing issues also does not require a lot of administrative work. The basic steps are:
1. Leave a comment to tell us that you are working on it
1. Leave a comment to tell us that you are working on it.
2. Fork our repository, and base your changes off of the 'develop' branch. Please create a new branch from develop which contains your changes. How you call it? We don't care.
3. Fix the issue! No biggie...
4. For good measure, check for any changes to the repo:
Expand All @@ -27,7 +27,7 @@ Fixing issues also does not require a lot of administrative work. The basic step
# If there are changes, pull and work on merge conflicts
git pull --rebase upstream develop
```
4. Make sure you have pushed your commits to your new branch and then create a pull request
4. Make sure you have pushed your commits to your new branch and then create a pull request.
5. Sit back and wait for us to take credit for your code - just kidding. All the fame and glory is yours.

## Reviews
Expand Down
2 changes: 1 addition & 1 deletion Help/Wiki/Basic/createnewlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ New-LabDefinition -Name $labName -DefaultVirtualizationEngine HyperV -VmPath D:\
```

- **New-LabDefinition** Parameters
- **Name**: The name if the lab to create. The name must be unique.
- **Name**: The name of the lab to create. The name must be unique.
- **DefaultVirtualizationEngine**: HyperV for local deployments or Azure to deploy into the cloud.
- **VmPath**: This is where AL creates the virtual machines. If this path is not defined AL will choose the fastest drive by trying not to use the system drive and create a folder there names "AutomatedLab-VMs".

Expand Down

0 comments on commit 21f9fe5

Please sign in to comment.