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

Quality: Cleanup of Get-Job examples #10448

Merged
merged 1 commit into from
Sep 22, 2023

Conversation

ehmiiz
Copy link
Contributor

@ehmiiz ehmiiz commented Sep 22, 2023

PR Summary

Prior to this PR, Get-Job has a few examples that needs to be cleaned up to align with the code formatting guidelines.

It also has a few examples that are non-functioning.

Example 8 states: The fifth command uses Invoke-Command to run a Get-Job command on the S2 computer.

It then does:
Invoke-Command -ComputerName S2 -ScriptBlock {Start-Job -ScriptBlock {Get-EventLog System}}

This is exactly what the forth command does in the same example.

I edited this to align with how one can manage a remote job on a remote computer

In example 4, the example is about how Get-Job accepts pipeline input. It does, but by propertyname. And since the example passes a simple string it will throw an error. I changed it so it passes a PSCustomObject with a Command NoteProperty, this works in 5.1 - 7.4.

I decided to change a few examples from Illustrative to Executable, since I feel that users would benefit more from being able to copy/paste them. It would be good if there where some guidelines on how to think here, generally.

My intention is to fix all the -Job cmdlets, but Get-Job had so many potential changes that I decided to split it from the future PR of the other cmdlets.

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit f5f8e56:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/Get-Job.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/Get-Job.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/Get-Job.md ✅Succeeded View (powershell-7.3)
reference/7.4/Microsoft.PowerShell.Core/Get-Job.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

@github-actions
Copy link

Expectations

Thanks for your submission! Here's a quick note to provide you with some context for what to expect from the docs team and the process now that you've submitted a PR. Even if you've contributed to this repo before, we strongly suggest reading this information; it might have changed since you last read it.

To see our process for reviewing PRs, please read our editor's checklist and process for managing pull requests in particular. Below is a brief, high-level summary of what to expect, but our contributor guide has expanded details.

The docs team begins to review your PR if you request them to or if your PR meets these conditions:

  • It is not a draft PR.
  • It does not have a WIP prefix in the title.
  • It passes validation and build steps.
  • It does not have any merge conflicts.
  • You have checked every box in the PR Checklist, indicating you have completed all required steps and marked your PR as Ready to Merge.

You can always request a review at any stage in your authoring process, the docs team is here to help! You do not need to submit a fully polished and finished draft; the docs team can help you get content ready for merge.

While reviewing your PR, the docs team may make suggestions, write comments, and ask questions. When all requirements are satisfied, the docs team marks your PR as Approved and merges it. Once your PR is merged, it is included the next time the documentation is published. For this project, the documentation is published daily at 3 p.m. Pacific Standard Time (PST).

@sdwheeler sdwheeler added the project-quality Project - used to label items that are part of the Quality project label Sep 22, 2023
@sdwheeler
Copy link
Contributor

@ehmiiz Thanks again for your help!

@sdwheeler sdwheeler merged commit b4ed2c3 into MicrosoftDocs:main Sep 22, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
project-quality Project - used to label items that are part of the Quality project
Development

Successfully merging this pull request may close these issues.

Quality: Example cleanup of the Get-Job cmdlet
2 participants