Skip to content

PSSA 1.21.0 docs changes from PSSA repo #99

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 7 commits into from
Sep 30, 2022

Conversation

bergmeister
Copy link
Contributor

@bergmeister bergmeister commented Aug 31, 2022

PR Summary

Copied over from PSSA repo after the most rcent PR 1835 there were changes from this repo were synced back. Please note that this version isn't released yet so you might want to wait with merging or publishing until then.

Related PRs

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.

@opbld33

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

@bergmeister
Copy link
Contributor Author

Just saw the message around relative links. Will inspect the diff and revert those changes. Putting PR back into draft.

@bergmeister bergmeister changed the title PSSA 1.21.0 docs changes from PSSA repo WIP PSSA 1.21.0 docs changes from PSSA repo Aug 31, 2022
@bergmeister bergmeister changed the title WIP PSSA 1.21.0 docs changes from PSSA repo PSSA 1.21.0 docs changes from PSSA repo Aug 31, 2022
@opbld33

This comment was marked as outdated.

@sdwheeler sdwheeler added the hold-for-pr Waiting - for PR merge label Aug 31, 2022
@opbld33

This comment was marked as outdated.

@sdwheeler
Copy link
Collaborator

@bergmeister Thanks for submitting the PR. I have marked it as hold-for-pr awaiting your release.

@bergmeister
Copy link
Contributor Author

@sdwheeler
Copy link
Collaborator

Thanks @sdwheeler . Can you sync the change in your last commit back to PSSA please: https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidSemicolonsAsLineTerminators.md

Yes.

@opbld31
Copy link

opbld31 commented Aug 31, 2022

Docs Build status updates of commit 5f81675:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/PSScriptAnalyzer/overview.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md ✅Succeeded View (ps-modules)

This comment lists only the first 25 files in the pull request.
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, 2022

Docs Build status updates of commit c99d53d:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/PSScriptAnalyzer/overview.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md ✅Succeeded View (ps-modules)

This comment lists only the first 25 files in the pull request.
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:

@bergmeister
Copy link
Contributor Author

@opbld31
Copy link

opbld31 commented Sep 29, 2022

Learn Build status updates of commit 2cc973f:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/PSScriptAnalyzer/overview.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AlignAssignmentStatement.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidAssignmentToAutomaticVariable.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueForMandatoryParameter.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidDefaultValueSwitchParameter.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalAliases.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalVars.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidInvokingEmptyMembers.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidLongLines.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidMultipleTypeAttributes.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidNullOrEmptyHelpMessageAttribute.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidOverwritingBuiltInCmdlets.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidSemicolonsAsLineTerminators.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidShouldContinueWithoutForce.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidTrailingWhitespace.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingComputerNameHardcoded.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingConvertToSecureStringWithPlainText.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDeprecatedManifestFields.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingDoubleQuotesForConstantString.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingEmptyCatchBlock.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingInvokeExpression.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPlainTextForPassword.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingPositionalParameters.md ✅Succeeded View (ps-modules)

This comment lists only the first 25 files in the pull request.
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:

@michaeltlombardi michaeltlombardi merged commit aa20333 into MicrosoftDocs:main Sep 30, 2022
@sdwheeler sdwheeler removed the hold-for-pr Waiting - for PR merge label Nov 1, 2022
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.

5 participants