Skip to content
This repository has been archived by the owner on Nov 9, 2020. It is now read-only.

Integrate with PowerShell Help system [SKIP CI] #1654

Merged
merged 2 commits into from
Jul 28, 2017

Conversation

shaominchen
Copy link
Contributor

@shaominchen shaominchen commented Jul 28, 2017

Integrate vDVS windows plugin installation script with PowerShell Help system.

Testing Done:

1. Print usage info if running script without any parameter:

PS C:\> .\install-vdvs.ps1
Usage: install-vdvs.ps1 [[-uri] <String>] [-uninstall]

2. Run Get-Help with this script

PS C:\> Get-Help .\install-vdvs.ps1

NAME
    C:\install-vdvs.ps1

SYNOPSIS
    Installation script for VMware vSphere Docker Volume Plugin.

SYNTAX
    C:\install-vdvs.ps1 [[-uri] <String>] [-uninstall] [<CommonParameters>]

DESCRIPTION
    This script helps to download, install, uninstall, and re-install VMware vSphere Docker Volume Plugin on your system.

RELATED LINKS
    https://vmware.github.io/docker-volume-vsphere/

REMARKS
    To see the examples, type: "get-help C:\install-vdvs.ps1 -examples".
    For more information, type: "get-help C:\install-vdvs.ps1 -detailed".
    For technical information, type: "get-help C:\install-vdvs.ps1 -full".
    For online help, type: "get-help C:\install-vdvs.ps1 -online"

3. Run "Get-Help -example"

PS C:\> Get-Help .\install-vdvs.ps1 -example

NAME
    C:\install-vdvs.ps1

SYNOPSIS
    Installation script for VMware vSphere Docker Volume Plugin.

    -------------------------- EXAMPLE 1 --------------------------

    PS C:\>./install-vdvs.ps1 https://bintray.com/vmware/vDVS/download_file?file_path=docker-volume-vsphere.zip

    -------------------------- EXAMPLE 2 --------------------------

    PS C:\>./install-vdvs.ps1 -uninstall

Copy link
Contributor

@venilnoronha venilnoronha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shaominchen shaominchen merged commit 07a5c99 into vmware-archive:master Jul 28, 2017
@shaominchen shaominchen deleted the issue_1645 branch July 28, 2017 20:33
@venilnoronha venilnoronha mentioned this pull request Jul 31, 2017
3 tasks
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants