Skip to content

Update platyPSHelp documentation #3166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 3, 2016
Merged

Conversation

cormacpayne
Copy link
Member

@cormacpayne cormacpayne commented Nov 2, 2016

Description

Fix for issue #3155

  • Changed name of documentation from platyps-help to platyPSHelp-documentation
  • Added information about path requirements that wasn't explicitly mentioned in documentation

This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

General Guidelines

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
  • The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • Pull request includes test coverage for the included changes.
  • PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

  • New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
  • Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThrough parameter.

Cmdlet Parameter Guidelines

  • Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
  • Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

@markcowl markcowl merged commit 6c44dcd into Azure:dev Nov 3, 2016
athipp added a commit to athipp/azure-powershell that referenced this pull request Nov 8, 2016
commit f8d45c8
Merge: a97dbc9 bb3f93c
Author: athipp <[email protected]>
Date:   Mon Nov 7 16:08:13 2016 -0800

    Merge branch 'dev' into athipp-dev2

commit a97dbc9
Merge: 3357844 75035b3
Author: athipp <[email protected]>
Date:   Mon Nov 7 16:08:02 2016 -0800

    Merge remote-tracking branch 'Azure/dev' into athipp-dev2

commit bb3f93c
Author: athipp <[email protected]>
Date:   Mon Nov 7 16:03:14 2016 -0800

    Add changelog.md and bumpup version

commit 37f7df4
Merge: 9e727f2 75035b3
Author: athipp <[email protected]>
Date:   Mon Nov 7 15:51:04 2016 -0800

    Merge remote-tracking branch 'Azure/dev' into dev

commit 3357844
Author: athipp <[email protected]>
Date:   Mon Nov 7 14:59:18 2016 -0800

    Rewmoving stale project.

    The existing test covers both.

commit c79a036
Author: athipp <[email protected]>
Date:   Mon Nov 7 12:59:14 2016 -0800

    Fixing .csproj files to remove empty tag

commit e00c7cd
Author: athipp <[email protected]>
Date:   Thu Nov 3 18:25:26 2016 -0700

    Updated parameter description

commit 128f13a
Merge: 59cee57 3d1beec
Author: athipp <[email protected]>
Date:   Thu Nov 3 18:06:58 2016 -0700

    Merge remote-tracking branch 'Azure/release-3.2.0' into athipp-dev2

commit 75035b3
Merge: 6c44dcd 7b01b2f
Author: Mark Cowlishaw <[email protected]>
Date:   Thu Nov 3 12:58:49 2016 -0700

    Merge pull request Azure#3167 from cormacpayne/move-profile-test

    Move Profile on-demand test to check-in

commit 6c44dcd
Merge: 49adbf4 00ee0bb
Author: Mark Cowlishaw <[email protected]>
Date:   Thu Nov 3 12:58:18 2016 -0700

    Merge pull request Azure#3166 from cormacpayne/update-platyps-doc

    Update platyPSHelp documentation

commit 49adbf4
Merge: a364bc2 0b5e9d1
Author: Mark Cowlishaw <[email protected]>
Date:   Thu Nov 3 12:38:46 2016 -0700

    Merge pull request Azure#3106 from Visual-Studio-China/dev

    [Hold]: Add CI to sync docs from source code repo to content repo

commit 7b01b2f
Author: cormacpayne <[email protected]>
Date:   Wed Nov 2 13:20:43 2016 -0700

    Add CheckIn trait to AzurePSComletMessageQueue test

commit 00ee0bb
Author: cormacpayne <[email protected]>
Date:   Wed Nov 2 11:52:25 2016 -0700

    Update platyPSHelp documentation

commit a364bc2
Author: Abhijeet <[email protected]>
Date:   Wed Nov 2 10:58:14 2016 -0700

    Updating paths for build env shortcut and Repo-Tasks module

    Updating paths to the script and shortcuts that were documented.

commit a72839c
Merge: d49c5cd 15bb4e1
Author: Cormac McCarthy <[email protected]>
Date:   Wed Nov 2 10:13:41 2016 -0700

    Merge pull request Azure#3165 from Azure/master

    Merge master -> dev for release 3.1.0

commit 15bb4e1
Merge: 64ad444 3d1beec
Author: Mark Cowlishaw <[email protected]>
Date:   Wed Nov 2 09:34:35 2016 -0700

    Merge pull request Azure#3163 from Azure/release-3.1.0

    [Release 3.1.0] Merge release-3.1.0 -> master

commit 59cee57
Author: athipp <[email protected]>
Date:   Mon Oct 31 18:05:16 2016 -0700

    updating help

commit a124d81
Author: athipp <[email protected]>
Date:   Mon Oct 31 17:51:20 2016 -0700

    Fix bug with token aquisition

commit 6515b3e
Author: athipp <[email protected]>
Date:   Mon Oct 31 10:50:58 2016 -0700

    Build error removed 'nameof'

commit d5a46e9
Author: athipp <[email protected]>
Date:   Mon Oct 31 08:55:47 2016 -0700

    Fixing build failure in analysisservices dataplane apis

commit a97425a
Author: athipp <[email protected]>
Date:   Sun Oct 30 14:42:59 2016 -0700

    fixing login bug

commit fb4a16b
Author: athipp <[email protected]>
Date:   Sun Oct 30 14:37:44 2016 -0700

    Fixing bug

commit 83fe3f1
Merge: 3d1de62 d462714
Author: athipp <[email protected]>
Date:   Sun Oct 30 14:21:15 2016 -0700

    Merge remote-tracking branch 'origin/dev' into athipp-dev2

commit 3d1de62
Merge: f183796 d49c5cd
Author: athipp <[email protected]>
Date:   Thu Oct 27 15:20:40 2016 -0700

    Merge remote-tracking branch 'Azure/dev' into athipp-dev2

commit f183796
Author: athipp <[email protected]>
Date:   Thu Oct 27 15:16:13 2016 -0700

    - The dataplane apis for Analysis Services has two apis
    1. Login-AsAzureAccount to login the analysis server. This will not use
    AzureRM login because this API on the server is not part of ARM spec. and
    the users of this will necessarily not have any subscription access.
    2. Restart-AzureAnalysisServer that will restart the server

commit 819266b
Merge: 29da4ce e2b100e
Author: athipp <[email protected]>
Date:   Wed Oct 26 11:22:04 2016 -0700

    Merge remote-tracking branch 'refs/remotes/Azure/dev' into athipp-dev2

commit 29da4ce
Author: athipp <[email protected]>
Date:   Wed Oct 26 11:21:59 2016 -0700

    Adding Dataplane API to analysis services powershell

commit 0b5e9d1
Author: Qingqing Sun <[email protected]>
Date:   Tue Oct 25 16:14:10 2016 +0800

    Add ci to sync docs from source code repo to content repo

commit 31b9155
Merge: 14fe256 a3c9a4e
Author: athipp <[email protected]>
Date:   Mon Oct 24 14:34:11 2016 -0700

    Merge remote-tracking branch 'refs/remotes/Azure/dev' into athipp-dev2
@cormacpayne cormacpayne deleted the update-platyps-doc branch January 27, 2017 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants