GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Migrate user docs to Docs repo by sdwheeler · Pull Request #19871 · PowerShell/PowerShell

Conversation

@sdwheeler

@sdwheeler Sean Wheeler (sdwheeler) commented Jun 29, 2023

Copy link
Copy Markdown
Contributor

PR Summary

The source repo should only contain docs for contributing to or maintaining the project. User-focused documentation has been moved to the MicrosoftDocs/PowerShell-Docs repo.

PR Context

Removed files from the docs/learning-powershell folder and update the FAQ.

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
  • Breaking changes
    • None
    • OR
    • Experimental feature(s) needed
      • Experimental feature name(s):
  • User-facing changes
    • Not Applicable
    • OR
    • Documentation needed
      • Issue filed:
  • Testing - New and feature
    • N/A or can only be tested interactively
    • OR
    • Make sure you've added a new test if existing tests do not effectively test the code changed
  • Tooling
    • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
    • OR
    • I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
      • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
        (which runs in a different PS Host).
        • Issue filed:
      • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
        • Issue filed:
      • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
        • Issue filed:
      • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
        • Issue filed:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@sdwheeler
Migrate user docs to Docs repo
b0da2a2
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added the Extra Large label Jun 29, 2023
@sdwheeler

Sean Wheeler (sdwheeler) commented Jun 29, 2023

Copy link
Copy Markdown
Contributor Author

Steve Lee (@SteveL-MSFT) We talked about moving this content in Shiproom.

andyleejordan reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added the Review - Needed The PR is being reviewed label Jul 7, 2023
@ghost

Deleted user (ghost) commented Jul 7, 2023

Copy link
Copy Markdown

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@sdwheeler Sean Wheeler (sdwheeler) added the CommunityDay-Small A small PR that the PS team has identified to prioritize to review label Jul 10, 2023
daxian-dbw
Dongbo Wang (daxian-dbw) approved these changes Jul 10, 2023
View reviewed changes

@daxian-dbw Dongbo Wang (daxian-dbw) left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@daxian-dbw Dongbo Wang (daxian-dbw) added CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log and removed Review - Needed The PR is being reviewed labels Jul 10, 2023
SteveL-MSFT
Steve Lee (SteveL-MSFT) requested changes Jul 10, 2023
View reviewed changes
Comment thread docs/FAQ.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@microsoft-github-policy-service microsoft-github-policy-service Bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 10, 2023
@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Jul 10, 2023
Sean Wheeler (sdwheeler) added 3 commits July 10, 2023 13:37
@sdwheeler
Fix spelling warnings and commit suggestion
35eac05
@sdwheeler
update spelling file again
9795452
@sdwheeler
update spelling file
1428365
andyleejordan
Andy Jordan (andyleejordan) approved these changes Jul 10, 2023
View reviewed changes

@andyleejordan Andy Jordan (andyleejordan) left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM! And I double-checked the links.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Sean Wheeler (sdwheeler) added 2 commits July 10, 2023 14:16
@sdwheeler
Fixed spelling errors
462b5ce
@sdwheeler
fix markdownlist error
95878d5
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented Jul 10, 2023

Copy link
Copy Markdown

This PR has 742 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Large
Size       : +98 -644
Percentile : 91.4%

Total files changed: 8

Change summary by file extension:
.spelling : +13 -0
.md : +85 -644

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

SteveL-MSFT
Steve Lee (SteveL-MSFT) approved these changes Jul 10, 2023
View reviewed changes
@daxian-dbw
Dongbo Wang (daxian-dbw) merged commit d9fff5b into PowerShell:master Jul 10, 2023
@sdwheeler
Sean Wheeler (sdwheeler) deleted the sdw-user-docs branch July 13, 2023 13:05
@MatthijsBlom Matthijs (MatthijsBlom) mentioned this pull request Oct 1, 2023
Links to learning resources are dead exercism/powershell#292
Closed
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@sdwheeler
Migrate user docs to the PowerShell-Docs repo (PowerShell#19871)
58ed098
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw Dongbo Wang (daxian-dbw) daxian-dbw approved these changes
@andyleejordan Andy Jordan (andyleejordan) andyleejordan approved these changes
@SteveL-MSFT Steve Lee (SteveL-MSFT) SteveL-MSFT approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log CommunityDay-Small A small PR that the PS team has identified to prioritize to review Extra Large

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@sdwheeler @daxian-dbw @andyleejordan @SteveL-MSFT
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.