-
Notifications
You must be signed in to change notification settings - Fork 317
Update build as we move help content to PowerShell-Docs #1537
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
Conversation
lzybkr
left a comment
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.
This seems mostly reasonable. Note that people have complained about being confused by docs that document unreleased work, so expect more of that considering this new process. I'm guessing it's unavoidable though since docs go live like almost immediately?
At any rate, when generating the about topic, the key bindings were generated automatically. Since this is no longer automated, the check script should parse the about topic and validate the key bindings are as expected.
|
@lzybkr Comments are addressed. The following 2 mismatches are sort of special: Default bindings from codeBindings from 'about_PSReadLine.help.txt'This is because |
lzybkr
left a comment
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.
I don't have an opinion on the private vi-mode methods, so I guess it's fine to make them public.
| } | ||
| } | ||
|
|
||
| $eol = "`r`n" |
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.
It seems a little silly to explicitly use `r`n when `n works too. Or you could use [Environment]::NewLine to make it "obvious" that it works cross platform even though as written it seems like should work on Linux anyway.
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.
I use CRLF explicitly here because the about_PSReadLine.help.txt pulled down by Update-Help uses CRLF end-of-line sequence, on both Windows and Unix plats.
If switching to LF, the wildcard matching all always fail. I added a comment there.
Will make them public in the next PR. |
The help content in PSReadLine repo has been synced to
PowerShell-Docsrepo at https://github.com/MicrosoftDocs/PowerShell-Docs/tree/staging/reference/7.1/PSReadLineThe most recent updates on the predictive suggestion feature were synced to the doc repo by the following 3 PRs:
This PR is to remove the docs folder in this repo and update build script to check help content only in release build.
The help content check is again the help content retrieved by
Update-Help.For daily development builds, we don't check help content because we don't want the development in this repo to be blocked by the doc deployment.
A PR template is added to make sure we track if documentation needs to be updated.
Changes in this PR:
docsandaz-cifoldersplatyPSCurrently, the deployed PSReadLine help content is missing following things:
Those changes have been synced to the PowerShell-Doc repo by the PRs mentioned above. So the next deployment will get us the latest help content.
Microsoft Reviewers: Open in CodeFlow