Skip to content

Conversation

@StevenBucher98
Copy link
Contributor

@StevenBucher98 StevenBucher98 commented Aug 31, 2023

PR Summary

This is first pass at creating a feedback provider doc. This doc outlines how to create a feedback provider that triggers on success and errors in the commandline. The success case only triggers if the user is using an aliased command and will provide feedback that it is in fact aliased and include the full name of the command. The error case will trigger when there is an error in the cmd and suggest the user try using Get-Help or check out online docs.

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

This comment was marked as outdated.

@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).

@learn-build-service-prod

This comment was marked as outdated.

@sdwheeler sdwheeler marked this pull request as draft September 1, 2023 20:57
@learn-build-service-prod

This comment was marked as outdated.

Copy link
Collaborator

@sdwheeler sdwheeler left a comment

Choose a reason for hiding this comment

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

@StevenBucher98 I did a full editorial pass with numerous changes. There is one TODO item left for you. Add instructions on how to build, package, and import the module.

@learn-build-service-prod

This comment was marked as outdated.

@sdwheeler sdwheeler requested a review from daxian-dbw September 1, 2023 21:40
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 7473827:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@StevenBucher98 StevenBucher98 marked this pull request as ready for review September 5, 2023 16:28
@sdwheeler
Copy link
Collaborator

@StevenBucher98 just waiting on sign-off from @daxian-dbw.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 7aed4de:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 7e467ee:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 7e2f212:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

…der.md

Co-authored-by: Dongbo Wang <dongbow@microsoft.com>
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 5f8fc8f:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 6c91de5:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit e3daaaf:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 3316faa:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 829949c:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-predictor.gif ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 0033920:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-predictor.gif ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 0cbbf63:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-predictor.gif ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 1e3b667:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-predictor.gif ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

Comment on lines 608 to 609
}

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
}
}

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 434d3e6:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-predictor.gif ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit e606b59:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-predictor.gif ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit d6d79aa:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-predictor.gif ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

daxian-dbw
daxian-dbw previously approved these changes Sep 7, 2023
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit a40ff6e:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/dev-cross-plat/create-feedback-provider.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-arch.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-fields.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-output.png ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/dev-cross-plat/media/create-feedback-provider/feedback-provider-predictor.gif ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/toc.yml ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler merged commit 839b193 into MicrosoftDocs:main Sep 8, 2023
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