Update Readme

Update readme formatting
This commit is contained in:
Kyle Ruddy
2016-07-15 14:50:05 -07:00
parent 9187c45589
commit 6c49ae183f

View File

@@ -1,31 +1,31 @@
# PowerCLI Community Repository # PowerCLI Community Repository
## Principles of Operations ## Principles of Operations
## Table of Contents ## Table of Contents
* Abstract * [Abstract](https://github.com/vmware/PowerCLI-Example-Scripts#abstract)
* Table of Contents * [Table of Contents](https://github.com/vmware/PowerCLI-Example-Scripts#table-of-contents)
* Content Restrictions * [Content Restrictions](https://github.com/vmware/PowerCLI-Example-Scripts#content-restrictions)
* Type of Content * [Type of Content](https://github.com/vmware/PowerCLI-Example-Scripts#type-of-content)
* Meta Information * [Meta Information](https://github.com/vmware/PowerCLI-Example-Scripts#meta-information)
* Required Information * [Required Information](https://github.com/vmware/PowerCLI-Example-Scripts#required-information)
* Suggested Information * [Suggested Information](https://github.com/vmware/PowerCLI-Example-Scripts#suggested-information)
* Suggested Quality Management * [Suggested Quality Management](https://github.com/vmware/PowerCLI-Example-Scripts#suggested-quality-management)
* General Best Practices * [General Best Practices](https://github.com/vmware/PowerCLI-Example-Scripts#general-best-practices)
* Alias Usage * [Alias Usage](https://github.com/vmware/PowerCLI-Example-Scripts#alias-usage)
* Scripts * [Scripts](https://github.com/vmware/PowerCLI-Example-Scripts#scripts)
* Modules * [Modules](https://github.com/vmware/PowerCLI-Example-Scripts#modules)
* Help Information * [Help Information](https://github.com/vmware/PowerCLI-Example-Scripts#help-information)
* Security * [Security](https://github.com/vmware/PowerCLI-Example-Scripts#security)
* Resource Maintenance * [Resource Maintenance](https://github.com/vmware/PowerCLI-Example-Scripts#resource-maintenance)
* Maintenance Ownership * [Maintenance Ownership](https://github.com/vmware/PowerCLI-Example-Scripts#maintenance-ownership)
* Filing issues * [Filing issues](https://github.com/vmware/PowerCLI-Example-Scripts#filing-isssues)
* Resolving issues * [Resolving issues](https://github.com/vmware/PowerCLI-Example-Scripts#resolving-issues)
* Getting Started * [Getting Started](https://github.com/vmware/PowerCLI-Example-Scripts#getting-started)
* Accessing the Repository * [Accessing the Repository](https://github.com/vmware/PowerCLI-Example-Scripts#accessing-the-repository)
* Adding Resources * [Adding Resources](https://github.com/vmware/PowerCLI-Example-Scripts#adding-resources)
* Additional Resources * [Additional Resources](https://github.com/vmware/PowerCLI-Example-Scripts#additional-resources)
* Discussions * [Discussions](https://github.com/vmware/PowerCLI-Example-Scripts#discussions)
* VMware Sample Exchange * [VMware Sample Exchange](https://github.com/vmware/PowerCLI-Example-Scripts#vmware-sample-exchange)
* VMWARE TECHNOLOGY PREVIEW LICENSE AGREEMENT * [VMWARE TECHNOLOGY PREVIEW LICENSE AGREEMENT](https://github.com/vmware/PowerCLI-Example-Scripts#vmware-technology-preview-license-agreement)
## Abstract ## Abstract
This document will serve for collaboration to identify the operating principles of a centralized PowerCLI Community Repository on GitHub. This document will serve for collaboration to identify the operating principles of a centralized PowerCLI Community Repository on GitHub.
@@ -54,17 +54,17 @@ The following information must be included with each submitted scripting resourc
* What does the resource do * What does the resource do
* Any KNOWN limitations or dependencies * Any KNOWN limitations or dependencies
* vSphere version, required modules, etc. * vSphere version, required modules, etc.
#### Note Placement Examples: **Note Placement Examples:**
Script: Top few lines > Script: Top few lines
Module: Module manifest > Module: Module manifest
#### Script Note Example: **Script Note Example:**
<# > <#
Script name: script_name.ps1 > Script name: script_name.ps1
Created on: 07/07/2016 > Created on: 07/07/2016
Author: Author Name, @TwitterHandle > Author: Author Name, @TwitterHandle
Description: The purpose of the script is to … > Description: The purpose of the script is to …
Dependencies: None known > Dependencies: None known
#> > #>
### Suggested Information ### Suggested Information
The following information should be included when possible. Inclusion of information provides valuable information to consumers of the resource. The following information should be included when possible. Inclusion of information provides valuable information to consumers of the resource.
@@ -72,7 +72,7 @@ The following information should be included when possible. Inclusion of informa
* PowerCLI build against which the script was developed/tested * PowerCLI build against which the script was developed/tested
* PowerShell version against which the script was developed/tested * PowerShell version against which the script was developed/tested
* OS platform version against which the script was tested/developed * OS platform version against which the script was tested/developed
* Keywords that make it easier to find a script (for example: VDS, health check) * Keywords that make it easier to find a script, for example: VDS, health check
## Suggested Quality Management ## Suggested Quality Management
This section describes guidelines put in place to maintain a standard of quality while also promoting broader contribution. This section describes guidelines put in place to maintain a standard of quality while also promoting broader contribution.
### General Best Practices ### General Best Practices
@@ -90,7 +90,7 @@ This section describes guidelines put in place to maintain a standard of quality
* The script should be easy to read and understand * The script should be easy to read and understand
* Place user-defined variables towards the top of the script * Place user-defined variables towards the top of the script
### Modules ### Modules
* The module file (PSM1) should contain only functions. A module manifest file (PSD1) should also be created and included. A module formatting file (format.ps1xml) is desirable but not a requirement. * The module file, PSM1, should contain only functions. A module manifest file, PSD1, should also be created and included. A module formatting file (format.ps1xml) is desirable but not a requirement.
* Use only standard verbs * Use only standard verbs
### Security ### Security
* Usage of PowerShells strict mode is preferred, but not required. * Usage of PowerShells strict mode is preferred, but not required.