Skip to content

Conversation

@Hrxn
Copy link
Contributor

@Hrxn Hrxn commented Apr 26, 2022

PR Summary

Improves the consistency and readability of about_Quoting_Rules.

PR Context

Check the boxes below to indicate the content affected by this PR.

Repository or docset configuration

  • Repo documentation and configuration (.git/.github/.vscode etc.)
  • Docs build files (.openpublishing.* and build scripts)
  • Docset configuration (docfx.json, mapping, bread, module folder)

Conceptual documentation

  • Files in docs-conceptual

Cmdlet reference & about_ topics
When changing cmdlet reference or about_ topics, the changes should be copied to all
relevant versions. Check the boxes below to indicate the versions affected by this change.

  • Preview content
  • Version 7.2 content
  • Version 7.1 content
  • Version 7.0 content
  • Version 5.1 content

PR Checklist

  • I have read the contributors guide and followed the style and process guidelines
  • PR has a meaningful title
  • PR is targeted at the staging branch
  • All relevant versions updated
  • Includes content related to issues and PRs - see Closing issues using keywords.
  • 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 and remove the prefix when
    the PR is ready.

@opbld30
Copy link

opbld30 commented Apr 26, 2022

Docs Build status updates of commit abee2d4:

✅ Validation status: passed

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

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
Copy link
Contributor

Hi @Hrxn, thanks so much for this contribution!

I notice that your PR is not marked as WIP but you also didn't check the boxes for updating all relevant versions or the PR being ready for merge.

These changes look good to me, if you're planning to update the rest of the versions of this document yourself I'm happy to wait on that or, if you prefer, I can go ahead and fix that up myself (the git commit will still show you authored, I'll just be added as a co-author, so you won't lose credit). Either way is fine with me!

@Hrxn
Copy link
Contributor Author

Hrxn commented Apr 26, 2022

Yeah, I'm aware. The thing is, when browsing any docs on docs.microsoft.com, one can simply use the handy Edit button to quickly suggest changes, because if you have a GitHub account you also automatically have an account on there, and I think this integration is a really good idea on Microsoft's part, but the changes one can propose only apply to the version of the documentation one was currently browsing. And, as far as I know, there is no other easy way to propagate any changes forward to different versions, etc.

I don't have a local clone of this PowerShell Docs repo right now, so I'd suggest that you go ahead and make these changes locally on your side, and then merge it from there, I think this would be easier.

@michaeltlombardi
Copy link
Contributor

Yeah, I definitely agree that the current implementation of the edit functionality leaves something to be desired for versioned documents - though for those specifically (which is where this friction is introduced) it's not often easy to automate a propagation of changes.

I'm not sure if you're aware, but for many repositories, including this one, you can use the web editor/codespaces functionality to open up a repository or pull request in the web editor, even if you don't have a copy cloned locally, by pressing . while on the files view of a repository or pull request. For example, to edit this PR in the web editor, you could navigate to the files tab and then press . or click this link.

In any case, I'll go ahead and propagate these changes and get them merged. Seriously, thank you for the contribution, it's deeply appreciated!

@opbld32
Copy link

opbld32 commented Apr 26, 2022

Docs Build status updates of commit 7fa2c61:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Quoting_Rules.md ✅Succeeded View (powershell-5.1)
reference/7.0/Microsoft.PowerShell.Core/About/about_Quoting_Rules.md ✅Succeeded View (powershell-7)
reference/7.1/Microsoft.PowerShell.Core/About/about_Quoting_Rules.md ✅Succeeded View (powershell-7.1)
reference/7.2/Microsoft.PowerShell.Core/About/about_Quoting_Rules.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/About/about_Quoting_Rules.md ✅Succeeded View (powershell-7.3)

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 1fc9e56 into MicrosoftDocs:staging Apr 26, 2022
michaeltlombardi pushed a commit that referenced this pull request Apr 26, 2022
* Improve consistency and readability of about_Quoting_Rules (#8764)

* Update quicklink for Az PowerShell

Co-authored-by: HRXN <Hrxn@users.noreply.github.com>
@Hrxn Hrxn deleted the patch-1 branch April 26, 2022 19:53
sdwheeler added a commit that referenced this pull request May 24, 2022
* Publish to live (#8228)

* Update versions for new releases (#8222)

* [WIP] Fixes #8224 - Updates Select-Object (#8225)

* Automatically committed changes.

* Apply suggestions from code review

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

* Updates for PR feedback

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

* Fixes #8220 - Reorder information in setup articles (#8226)

* Reorder information in setup articles

* fix broken links

* Update reference/docs-conceptual/install/Installing-PowerShell-on-Windows.md

Co-authored-by: Chase Wilson <31453523+chasewilson@users.noreply.github.com>

Co-authored-by: Chase Wilson <31453523+chasewilson@users.noreply.github.com>

* Publish to live (#8230)

* Update versions for new releases (#8222)

* [WIP] Fixes #8224 - Updates Select-Object (#8225)

* Automatically committed changes.

* Apply suggestions from code review

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

* Updates for PR feedback

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

* Fixes #8220 - Reorder information in setup articles (#8226)

* Reorder information in setup articles

* fix broken links

* Update reference/docs-conceptual/install/Installing-PowerShell-on-Windows.md

Co-authored-by: Chase Wilson <31453523+chasewilson@users.noreply.github.com>

* Fix versioned URLs (#8229)

Co-authored-by: Chase Wilson <31453523+chasewilson@users.noreply.github.com>

* 2/03 PM Publish (#8566)

* Add 7.3 to module history (#8559)

* Add 7.3 to module history

* fix typo

* fix more typos

* Fix typo (#8564)

* Insert missing angle-bracket in class syntax block (#8563)

* Add no-loc metadata to avoid over-translation (#8565)

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>
Co-authored-by: Guilherme Gonzaga <guilhermgonzaga@gmail.com>

* Merge latest changes to live (#8766)

* Improve consistency and readability of about_Quoting_Rules (#8764)

* Update quicklink for Az PowerShell

Co-authored-by: HRXN <Hrxn@users.noreply.github.com>

* Publish to live (#8792)

* Change staging branch references to main (#8790)

* Add no-loc metadata (#8791)

* Edit basic grammar.

* Edit Note regarding prepending Get verb.

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>
Co-authored-by: Chase Wilson <31453523+chasewilson@users.noreply.github.com>
Co-authored-by: huypub <38988242+huypub@users.noreply.github.com>
Co-authored-by: Guilherme Gonzaga <guilhermgonzaga@gmail.com>
Co-authored-by: HRXN <Hrxn@users.noreply.github.com>
Co-authored-by: Alma Jenks <v-alje@microsoft.com>
Co-authored-by: JiayueHu <36248303+JiayueHu@users.noreply.github.com>
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.

Improve Consistency and Readability of about_Quoting_Rules

4 participants