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

Add details to 'about_Modules' topic #11276

Merged
merged 3 commits into from
Aug 9, 2024

Conversation

guillermooo
Copy link
Contributor

@guillermooo guillermooo commented Jul 17, 2024

PR Summary

Reorganize paragraphs and try to provide details why modules can help.

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.

@guillermooo
Copy link
Contributor Author

@michaeltlombardi Before updating the other files, please check if this looks OK to you.

Copy link
Contributor

Learn Build status updates of commit 4af23e8:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Modules.md ✅Succeeded View (powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

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

Copy link
Contributor

@michaeltlombardi michaeltlombardi left a comment

Choose a reason for hiding this comment

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

@guillermooo - I'm sorry for the late reply to your PR, it looks like my prior review didn't submit correctly.

What you have here looks good, I like the restructuring and clarifications. I have a few minor recommendations, but nothing major. I think you can continue this work and I'll make sure to review it promptly.

One thing to keep in mind is that we need to limit the line length in about topics to 80 characters or fewer (see the markdownlint config). You can use the Reflow Markdown VS Code extension to make that task easier. I see that our contributor guide doesn't point this out, so I'll update that shortly.

Copy link
Contributor

Learn Build status updates of commit f1f0f8d:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Modules.md ✅Succeeded View (powershell-5.1)

For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler marked this pull request as ready for review August 9, 2024 14:45
Copy link
Contributor

Learn Build status updates of commit 24f6253:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Modules.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/About/about_Modules.md ✅Succeeded View (powershell-7.2)
reference/7.4/Microsoft.PowerShell.Core/About/about_Modules.md ✅Succeeded View (powershell-7.4)
reference/7.5/Microsoft.PowerShell.Core/About/about_Modules.md ✅Succeeded View (powershell-7.5)

For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler merged commit 2422d90 into MicrosoftDocs:main Aug 9, 2024
6 of 9 checks passed
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