Skip to content

Conversation

YuriySamorodov
Copy link
Contributor

@YuriySamorodov YuriySamorodov commented Mar 18, 2019

Rewrote code examples. Many of those did not work at all like New-PSSessionConfigurationFile. And many did not look good.

Version(s) of document impacted

  • Impacts 6.next document
  • Impacts 6 document
  • Impacts 5.1 document
  • Impacts 5.0 document
  • Impacts 4.0 document
  • Impacts 3.0 document

Reason(s) for not updating all version of documents

  • The documented feature was introduced in version (list version here) of PowerShell
  • This issue only shows up in version (list version(s) here) of the document
  • This PR partially fixes the issue, and issue # tracks the remaining work

Rewrote code examples. Many of those did not work at all like New-PSSessionConfigurationFile. And many did not look good.
@zjalexander
Copy link
Contributor

OPS Build status updates of commit 4f6bbbd:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :66:(1301) '```powershell
    Register-PSSessionConfiguration -Pa...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

git markup fix attempt

@zjalexander
Copy link
Contributor

OPS Build status updates of commit fd25170:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :69:(1301) '```powershell
    Register-PSSessionConfiguration -Pa...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt #2

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 2032d1b:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :69:(1301) '```powershell
    Register-PSSessionConfiguration -Pa...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 3

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 95d54f9:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :69:(1301) '```powershell
    Register-PSSessionConfiguration -Pa...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 4

@zjalexander
Copy link
Contributor

OPS Build status updates of commit eab0345:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :70:(1301) '```powershell
    Register-PSSessionConfiguration -Pa...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 5

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 8e3f91e:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :70:(1301) '```powershell
    Register-PSSessionConfiguration -Pa...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 6

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 0137079:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :73:(1301) '```powershell
    Register-PSSessionConfiguration -Pa...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 7

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 9111818:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :72:(1301) '```powershell
    Register-PSSessionConfiguration -Pa...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 12893cc:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :72:(1301) '```
    Register-PSSessionConfiguration -Path .\NoLan...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 9

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 9

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 8df2b4a:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :60:(1037) '#### Creating resticted sessions with files

'
Expect Heading level 3

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

@sdwheeler
Copy link
Collaborator

@YuriySamorodov There is no way to accomplish the formatting you are trying to do. See:
https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/contributing/6-UPDATING-REFERENCE.md#writing-examples

This is a limitation of PlatyPS.

The schema does not allow code blocks to be separated by paragraphs in an example. The valid schema is:

### Example #X title
0 or more paragraphs
1 or more code blocks
0 or more paragraphs.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 10

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 3dd86c7:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :60:(1037) '###

'
Unexpected header name #

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

@YuriySamorodov
Copy link
Contributor Author

@sdwheeler Thank you very much for taking your time explaining me that. Did not realize what the limitations were until I looked into Powershell-Docs-CI console.
Currently I am in the middle of trying to find out what we can do in this case. Problem is that code blocks do not have auto wrapping and comments will not get to the new line until line break or caret return symbol. I just want examples be more readable....
Thank you for your patience and sorry for the errors

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 11

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 352ca68:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :60:(1037) '###

'
Unexpected header name #

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 11

@zjalexander
Copy link
Contributor

OPS Build status updates of commit fc1e7f7:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :130:(1748) '```powershell
    Set-PSSessionConfiguration -Name IT...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 12

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 922dbde:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :168:(2628) '```powershell
    Test-PSSessionConfigurationFile -Pa...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

markup fix attempt 13

@zjalexander
Copy link
Contributor

OPS Build status updates of commit a14924c:

✅ Validation status: passed

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ✅Succeeded View (powershell-6)

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Replaced fake sections with the list items
Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

Replaced fake sections with the bullet list items

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 4cea5a8:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :69:(1303) '```powershell
    Register-PSSessionConfiguration -Pa...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Rolled back the changes to the state of markup fix attempt 13
Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

Rolled back the changes to the state of markup fix attempt 13

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 028a5fc:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ❌Error Details

reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md

  • [Error] Unable to load file '6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md' via processor 'AzureCliDocumentProcessor': :162:(2455) '```powershell
    AliasDefinitions = @(@{Name='slst';...'
    Expect Heading

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Formatted alias reference with Italics
Copy link
Contributor Author

@YuriySamorodov YuriySamorodov left a comment

Choose a reason for hiding this comment

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

Formatted alias reference with Italics

@zjalexander
Copy link
Contributor

OPS Build status updates of commit 0dfc4b4:

✅ Validation status: passed

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/New-PSSessionConfigurationFile.md ✅Succeeded View (powershell-6)

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

@sdwheeler
Copy link
Collaborator

@YuriySamorodov I appreciate your efforts but there are several issues with this article and we cannot accept the hack you found to get around the PlatyPS limitations. I have edited the article and fixed the issues. See #4024

@sdwheeler sdwheeler closed this Mar 21, 2019
@sdwheeler sdwheeler added the do-not-merge Tag - closed without merging label Mar 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge Tag - closed without merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants