Skip to content
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

Resolves #2056 #2129

Merged
merged 4 commits into from
Sep 29, 2020
Merged

Resolves #2056 #2129

merged 4 commits into from
Sep 29, 2020

Conversation

velkovb
Copy link
Contributor

@velkovb velkovb commented Sep 18, 2020

Fix examples.
#2056

@opbld32
Copy link

opbld32 commented Sep 18, 2020

Docs Build status updates of commit b3788d4:

✅ Validation status: passed

File Status Preview URL Details
docset/windows/addsadministration/Get-ADUser.md ✅Succeeded
docset/winserver2012-ps/activedirectory/Get-ADUser.md ✅Succeeded
docset/winserver2012r2-ps/addsadministration/Get-ADUser.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@opbld30
Copy link

opbld30 commented Sep 18, 2020

Docs Build status updates of commit 6ab3a71:

✅ Validation status: passed

File Status Preview URL Details
docset/windows/addsadministration/Get-ADUser.md ✅Succeeded
docset/winserver2012-ps/activedirectory/Get-ADUser.md ✅Succeeded
docset/winserver2012r2-ps/addsadministration/Get-ADUser.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@o0nj
Copy link
Contributor

o0nj commented Sep 23, 2020

@dariomws @get-itips @tseward

Peer review needed for this PR.

cc @JohanFreelancer9 for copy editing.

Thank you.

Copy link
Contributor

@get-itips get-itips left a comment

Choose a reason for hiding this comment

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

I am ok with it, only one thing, are we going to leave cmdlet's output on examples? Is this vital for the article? @tseward @dariomws

@dariomws
Copy link
Contributor

@get-itips not sure about what we usually do here, but for me looks better without them because you can copy and paste the command succesfully.

@velkovb
Copy link
Contributor Author

velkovb commented Sep 23, 2020

@dariomws @get-itips Some will complain that there is no example of the output of the get command, some that when there is output they cannot copy and paste :) I think it is useful to see the output but somehow be able to copy only the command, though I do not think it is currently possible.

@dariomws
Copy link
Contributor

@dariomws @get-itips Some will complain that there is no example of the output of the get command, some that when there is output they cannot copy and paste :) I think it is useful to see the output but somehow be able to copy only the command, though I do not think it is currently possible.

Maybe we can put the output in the description of the example. @get-itips @velkovb What do you think?

@get-itips
Copy link
Contributor

get-itips commented Sep 24, 2020

Maybe we can put the output in the description of the example. @get-itips @velkovb What do you think?

Has that been done in the past?

Copy link
Contributor

@JohanFreelancer9 JohanFreelancer9 left a comment

Choose a reason for hiding this comment

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

Copy review.

@opbld31
Copy link

opbld31 commented Sep 24, 2020

Docs Build status updates of commit d41a188:

✅ Validation status: passed

File Status Preview URL Details
docset/windows/addsadministration/Get-ADUser.md ✅Succeeded
docset/winserver2012-ps/activedirectory/Get-ADUser.md ✅Succeeded
docset/winserver2012r2-ps/addsadministration/Get-ADUser.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@opbld33
Copy link

opbld33 commented Sep 24, 2020

Docs Build status updates of commit d41a188:

✅ Validation status: passed

File Status Preview URL Details
docset/windows/addsadministration/Get-ADUser.md ✅Succeeded
docset/winserver2012-ps/activedirectory/Get-ADUser.md ✅Succeeded
docset/winserver2012r2-ps/addsadministration/Get-ADUser.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com>
@opbld30
Copy link

opbld30 commented Sep 24, 2020

Docs Build status updates of commit 7630f12:

✅ Validation status: passed

File Status Preview URL Details
docset/windows/addsadministration/Get-ADUser.md ✅Succeeded
docset/winserver2012-ps/activedirectory/Get-ADUser.md ✅Succeeded
docset/winserver2012r2-ps/addsadministration/Get-ADUser.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@dariomws
Copy link
Contributor

Maybe we can put the output in the description of the example. @get-itips @velkovb What do you think?

Has that been done in the past?

I don't remember It's true, but I saw that some cmdlets have a explanation or example of the output in the cmdlet description section.

@get-itips
Copy link
Contributor

Let's leave it as is..

@o0nj o0nj added the Sign off The pull request is ready to be reviewed and merged by PubOps label Sep 29, 2020
@tiburd tiburd self-assigned this Sep 29, 2020
@tiburd tiburd added the In review PubOps is reviewing the pull request label Sep 29, 2020
@opbld30
Copy link

opbld30 commented Sep 29, 2020

Docs Build status updates of commit 3f0808a:

✅ Validation status: passed

File Status Preview URL Details
docset/windows/addsadministration/Get-ADUser.md ✅Succeeded
docset/winserver2012-ps/activedirectory/Get-ADUser.md ✅Succeeded
docset/winserver2012r2-ps/addsadministration/Get-ADUser.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@tiburd tiburd merged commit a6c7c60 into MicrosoftDocs:master Sep 29, 2020
@velkovb velkovb deleted the fix-2056-examples branch September 29, 2020 18:22
@velkovb
Copy link
Contributor Author

velkovb commented Oct 31, 2020

@get-itips @dariomws So here is what I recently found on the output question:
PowerShell-Docs style guide

Get-Command -Module Microsoft.PowerShell.Security
CommandType  Name                        Version    Source
-----------  ----                        -------    ------
Cmdlet       ConvertFrom-SecureString    3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       ConvertTo-SecureString      3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-Acl                     3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-AuthenticodeSignature   3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-CmsMessage              3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-Credential              3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-ExecutionPolicy         3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-PfxCertificate          3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       New-FileCatalog             3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Protect-CmsMessage          3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Set-Acl                     3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Set-AuthenticodeSignature   3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Set-ExecutionPolicy         3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Test-FileCatalog            3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Unprotect-CmsMessage        3.0.0.0    Microsoft.PowerShell.Security

I will start doing this in PRs :)

@dariomws
Copy link
Contributor

dariomws commented Nov 2, 2020

Testing:

Get-Command -Module Microsoft.PowerShell.Security
CommandType  Name                        Version    Source
-----------  ----                        -------    ------
Cmdlet       ConvertFrom-SecureString    3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       ConvertTo-SecureString      3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-Acl                     3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-AuthenticodeSignature   3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-CmsMessage              3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-Credential              3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-ExecutionPolicy         3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Get-PfxCertificate          3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       New-FileCatalog             3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Protect-CmsMessage          3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Set-Acl                     3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Set-AuthenticodeSignature   3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Set-ExecutionPolicy         3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Test-FileCatalog            3.0.0.0    Microsoft.PowerShell.Security
Cmdlet       Unprotect-CmsMessage        3.0.0.0    Microsoft.PowerShell.Security

@dariomws
Copy link
Contributor

dariomws commented Nov 2, 2020

@velkovb like it! Let's try, I think we should be able to copy the command separately in this way.

Thanks!

@velkovb
Copy link
Contributor Author

velkovb commented Nov 2, 2020

@dariomws I created a new PR to implement that - #2190
@get-itips @e0i

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
In review PubOps is reviewing the pull request Sign off The pull request is ready to be reviewed and merged by PubOps
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants