voltron/PowerCLI-Example-Scripts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Readme

Browse Source 
Update readme formatting
This commit is contained in:
Kyle Ruddy
2016-07-15 14:50:05 -07:00
parent 9187c45589
commit 6c49ae183f
1 changed files with 40 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
README.md
View File

@@ -1,31 +1,31 @@
# PowerCLI Community Repository
## Principles of Operations
## Table of Contents
* Abstract
* Table of Contents
* Content Restrictions
* Type of Content
* Meta Information
* Required Information
* Suggested Information
* Suggested Quality Management
* General Best Practices
* Alias Usage
* Scripts
* Modules
* Help Information
* Security
* Resource Maintenance
* Maintenance Ownership
* Filing issues
* Resolving issues
* Getting Started
* Accessing the Repository
* Adding Resources
* Additional Resources
* Discussions
* VMware Sample Exchange
* VMWARE TECHNOLOGY PREVIEW LICENSE AGREEMENT
* [Abstract](https://github.com/vmware/PowerCLI-Example-Scripts#abstract)
* [Table of Contents](https://github.com/vmware/PowerCLI-Example-Scripts#table-of-contents)
* [Content Restrictions](https://github.com/vmware/PowerCLI-Example-Scripts#content-restrictions)
* [Type of Content](https://github.com/vmware/PowerCLI-Example-Scripts#type-of-content)
* [Meta Information](https://github.com/vmware/PowerCLI-Example-Scripts#meta-information)
* [Required Information](https://github.com/vmware/PowerCLI-Example-Scripts#required-information)
* [Suggested Information](https://github.com/vmware/PowerCLI-Example-Scripts#suggested-information)
* [Suggested Quality Management](https://github.com/vmware/PowerCLI-Example-Scripts#suggested-quality-management)
* [General Best Practices](https://github.com/vmware/PowerCLI-Example-Scripts#general-best-practices)
* [Alias Usage](https://github.com/vmware/PowerCLI-Example-Scripts#alias-usage)
* [Scripts](https://github.com/vmware/PowerCLI-Example-Scripts#scripts)
* [Modules](https://github.com/vmware/PowerCLI-Example-Scripts#modules)
* [Help Information](https://github.com/vmware/PowerCLI-Example-Scripts#help-information)
* [Security](https://github.com/vmware/PowerCLI-Example-Scripts#security)
* [Resource Maintenance](https://github.com/vmware/PowerCLI-Example-Scripts#resource-maintenance)
* [Maintenance Ownership](https://github.com/vmware/PowerCLI-Example-Scripts#maintenance-ownership)
* [Filing issues](https://github.com/vmware/PowerCLI-Example-Scripts#filing-isssues)
* [Resolving issues](https://github.com/vmware/PowerCLI-Example-Scripts#resolving-issues)
* [Getting Started](https://github.com/vmware/PowerCLI-Example-Scripts#getting-started)
* [Accessing the Repository](https://github.com/vmware/PowerCLI-Example-Scripts#accessing-the-repository)
* [Adding Resources](https://github.com/vmware/PowerCLI-Example-Scripts#adding-resources)
* [Additional Resources](https://github.com/vmware/PowerCLI-Example-Scripts#additional-resources)
* [Discussions](https://github.com/vmware/PowerCLI-Example-Scripts#discussions)
* [VMware Sample Exchange](https://github.com/vmware/PowerCLI-Example-Scripts#vmware-sample-exchange)
* [VMWARE TECHNOLOGY PREVIEW LICENSE AGREEMENT](https://github.com/vmware/PowerCLI-Example-Scripts#vmware-technology-preview-license-agreement)
## Abstract
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
* Any KNOWN limitations or dependencies
* vSphere version, required modules, etc.
#### Note Placement Examples:
Script: Top few lines
Module: Module manifest
#### Script Note Example:
<#
Script name: script_name.ps1
Created on: 07/07/2016
Author: Author Name, @TwitterHandle
Description: The purpose of the script is to …
Dependencies: None known
#>
**Note Placement Examples:**
> Script: Top few lines
> Module: Module manifest
**Script Note Example:**
> <#
> Script name: script_name.ps1
> Created on: 07/07/2016
> Author: Author Name, @TwitterHandle
> Description: The purpose of the script is to …
> Dependencies: None known
> #>
### Suggested Information
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
* PowerShell version against which the script was developed/tested
* 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
This section describes guidelines put in place to maintain a standard of quality while also promoting broader contribution.
### 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
* Place user-defined variables towards the top of the script
### 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
### Security
* Usage of PowerShell’s strict mode is preferred, but not required.