[BUG] documentation small bugs
Reporting an Issue or Missing Feature
Hi, π. I love the way the docs are readable and organized on your site π. I created a small parser for them in order to create snippets json needed for a small and very simple VS Code extension I created. The script pointed the following issues:
- [x] Add-PnPFileToSiteTemplate - the description section is added twice. The first time is with PscalCase which probably should be all UPERCASE and the second section is emtpy - we should remove the second one and align the casing of the first one to be consistent with rest of the docs
- [x] Copy-PnPTeamsTeam - has wrong title, currently it is Copy-PnPList but should be Copy-PnPTeamsTeam
Also the following cmdlets have empty description section (It would be nice if at least one sentence would be added to explain what is possible with this command π€):
- [x] Add-PnPApp
- [x] Add-PnPAvailableSiteClassification
- [x] Add-PnPAzureADGroupMember
- [x] Add-PnPAzureADGroupOwner
- [x] Add-PnPContentTypesFromContentTypeHub
- [x] Add-PnPContentTypeToDocumentSet
- [x] Add-PnPContentTypeToList
- [x] Add-PnPDataRowsToSiteTemplate
- [x] Add-PnPDocumentSet
- [x] Add-PnPFieldFromXml
- [x] Add-PnPFieldToContentType
- [x] Add-PnPFolder
- [x] Add-PnPGroupMember
- [x] Add-PnPHtmlPublishingPageLayout
- [x] Add-PnPIndexedProperty
- [x] Add-PnPListDesign
- [x] Add-PnPListFoldersToSiteTemplate
- [x] Add-PnPListItem
- [x] Add-PnPListItemComment
- [x] Add-PnPMasterPage
- [x] Add-PnPMicrosoft365GroupMember
- [x] Add-PnPMicrosoft365GroupOwner
- [x] Add-PnPOrgNewsSite
- [x] Add-PnPPageSection
- [x] Add-PnPPublishingImageRendition
- [x] Add-PnPPublishingPage
- [x] Add-PnPPublishingPageLayout
- [x] Add-PnPSiteCollectionAppCatalog
- [x] Add-PnPSiteDesign
- [x] Add-PnPSiteDesignTask
- [x] Add-PnPSiteScript
- [x] Add-PnPSiteScriptPackage
- [x] Add-PnPSiteTemplate
- [x] Add-PnPTeamsChannel
- [x] Add-PnPTeamsChannelUser
- [x] Add-PnPTeamsTab
- [x] Add-PnPTenantSequence
- [x] Add-PnPTenantSequenceSite
- [x] Add-PnPTenantSequenceSubSite
- [x] Add-PnPView
- [x] Add-PnPVivaConnectionsDashboardACE
- [x] Add-PnPWebhookSubscription
- [x] Add-PnPWebPartToWebPartPage
- [x] Add-PnPWebPartToWikiPage
- [x] Add-PnPWikiPage
- [x] Clear-PnPAzureADGroupMember
- [x] Clear-PnPAzureADGroupOwner
- [x] Clear-PnPListItemAsRecord
- [x] Clear-PnPMicrosoft365GroupMember
- [x] Clear-PnPMicrosoft365GroupOwner
- [x] Clear-PnPRecycleBinItem
- [x] Clear-PnPTenantAppCatalogUrl
- [x] Convert-PnPFolderToSiteTemplate
- [x] Convert-PnPSiteTemplate
- [x] Disable-PnPSiteClassification
- [x] Enable-PnPFeature
- [x] Enable-PnPSiteClassification
- [x] Export-PnPListToSiteTemplate
- [x] Export-PnPPage
- [x] Export-PnPTaxonomy
- [x] Export-PnPTermGroupToXml
- [x] Find-PnPFile
- [ ] Get-PnPAlert
- [ ] Get-PnPApp
- [ ] Get-PnPAuditing
- [ ] Get-PnPAvailableLanguage
- [ ] Get-PnPAzureADGroup
- [ ] Get-PnPAzureADGroupMember
- [ ] Get-PnPAzureADGroupOwner
- [ ] Get-PnPAzureADUser
- [ ] Get-PnPAzureCertificate
- [ ] Get-PnPCompatibleHubContentTypes
- [ ] Get-PnPContentType
- [ ] Get-PnPContentTypePublishingHubUrl
- [ ] Get-PnPContentTypePublishingStatus
- [ ] Get-PnPDeletedMicrosoft365Group
- [ ] Get-PnPDocumentSetTemplate
- [ ] Get-PnPLabel
- [ ] Get-PnPListInformationRightsManagement
- [ ] Get-PnPListItem
- [ ] Get-PnPListItemAttachment
- [ ] Get-PnPListItemPermission
- [ ] Get-PnPListRecordDeclaration
- [ ] Get-PnPMasterPage
- [ ] Get-PnPMessageCenterAnnouncement
- [ ] Get-PnPMicrosoft365Group
- [ ] Get-PnPMicrosoft365GroupOwner
- [ ] Get-PnPMicrosoft365GroupSettings
- [ ] Get-PnPMicrosoft365GroupSettingTemplates
- [ ] Get-PnPNavigationNode
- [ ] Get-PnPOrgAssetsLibrary
- [ ] Get-PnPOrgNewsSite
- [ ] Get-PnPPropertyBag
- [ ] Get-PnPPublishingImageRendition
- [ ] Get-PnPRequestAccessEmails
- [ ] Get-PnPRoleDefinition
- [ ] Get-PnPSearchConfiguration
- [ ] Get-PnPSearchCrawlLog
- [ ] Get-PnPSearchSettings
- [ ] Get-PnPServiceCurrentHealth
- [ ] Get-PnPServiceHealthIssue
- [ ] Get-PnPSite
- [ ] Get-PnPSiteClosure
- [ ] Get-PnPSiteDesignRights
- [ ] Get-PnPSiteDesignRun
- [ ] Get-PnPSiteDesignRunStatus
- [ ] Get-PnPSiteDesignTask
- [ ] Get-PnPSitePolicy
- [ ] Get-PnPSiteScript
- [ ] Get-PnPSiteSearchQueryResults
- [ ] Get-PnPSiteTemplate
- [ ] Get-PnPStorageEntity
- [ ] Get-PnPSubWeb
- [ ] Get-PnPTaxonomySession
- [ ] Get-PnPTeamsApp
- [ ] Get-PnPTeamsChannel
- [ ] Get-PnPTeamsChannelFilesFolder
- [ ] Get-PnPTeamsChannelMessage
- [ ] Get-PnPTeamsChannelMessageReply
- [ ] Get-PnPTeamsChannelUser
- [ ] Get-PnPTeamsTab
- [ ] Get-PnPTeamsTeam
- [ ] Get-PnPTeamsUser
- [ ] Get-PnPTemporarilyDisableAppBar
- [ ] Get-PnPTenantAppCatalogUrl
- [ ] Get-PnPTenantId
- [ ] Get-PnPTenantInstance
- [ ] Get-PnPTenantSequence
- [ ] Get-PnPTenantSequenceSite
- [ ] Get-PnPTenantTemplate
- [ ] Get-PnPTermGroup
- [ ] Get-PnPTheme
- [ ] Get-PnPUnifiedAuditLog
- [ ] Get-PnPView
- [ ] Get-PnPVivaConnectionsDashboardACE
- [ ] Get-PnPWeb
- [ ] Get-PnPWebhookSubscriptions
- [ ] Get-PnPWebPartProperty
- [ ] Get-PnPWebPartXml
- [ ] Get-PnPWikiPageContent
- [ ] Grant-PnPHubSiteRights
- [ ] Grant-PnPSiteDesignRights
- [ ] Grant-PnPTenantServicePrincipalPermission
- [ ] Import-PnPTaxonomy
- [ ] Import-PnPTermGroupFromXml
- [ ] Install-PnPApp
- [ ] Invoke-PnPSiteTemplate
- [ ] Invoke-PnPTenantTemplate
- [ ] Invoke-PnPWebAction
- [ ] Measure-PnPList
- [ ] Measure-PnPWeb
- [ ] Move-PnPFolder
- [ ] Move-PnPListItemToRecycleBin
- [ ] Move-PnPRecycleBinItem
- [ ] New-PnPAzureADGroup
- [ ] New-PnPAzureCertificate
- [ ] New-PnPExtensibilityHandlerObject
- [ ] New-PnPList
- [ ] New-PnPMicrosoft365Group
- [ ] New-PnPMicrosoft365GroupSettings
- [ ] New-PnPSiteTemplate
- [ ] New-PnPSiteTemplateFromFolder
- [ ] New-PnPTeamsApp
- [ ] New-PnPTeamsTeam
- [ ] New-PnPTenantSequence
- [ ] New-PnPTenantSequenceCommunicationSite
- [ ] New-PnPTenantSequenceTeamNoGroupSite
- [ ] New-PnPTenantSequenceTeamNoGroupSubSite
- [ ] New-PnPTenantSequenceTeamSite
- [ ] New-PnPTenantTemplate
- [ ] New-PnPTermGroup
- [ ] New-PnPTermSet
- [ ] New-PnPUser
- [ ] New-PnPWeb
- [ ] Publish-PnPApp
- [ ] Publish-PnPContentType
- [ ] Read-PnPTenantTemplate
- [ ] Register-PnPAppCatalogSite
- [ ] Remove-PnPAlert
- [ ] Remove-PnPApp
- [ ] Remove-PnPAvailableSiteClassification
- [ ] Remove-PnPAzureADGroup
- [ ] Remove-PnPAzureADGroupMember
- [ ] Remove-PnPAzureADGroupOwner
- [ ] Remove-PnPContentType
- [ ] Remove-PnPContentTypeFromDocumentSet
- [ ] Remove-PnPContentTypeFromList
- [ ] Remove-PnPCustomAction
- [ ] Remove-PnPDeletedMicrosoft365Group
- [ ] Remove-PnPField
- [ ] Remove-PnPFieldFromContentType
- [ ] Remove-PnPFile
- [ ] Remove-PnPFileFromSiteTemplate
- [ ] Remove-PnPFolder
- [ ] Remove-PnPGraphSubscription
- [ ] Remove-PnPGroup
- [ ] Remove-PnPGroupMember
- [ ] Remove-PnPHomeSite
- [ ] Remove-PnPHubSiteAssociation
- [ ] Remove-PnPIndexedProperty
- [ ] Remove-PnPJavaScriptLink
- [ ] Remove-PnPKnowledgeHubSite
- [ ] Remove-PnPList
- [ ] Remove-PnPListDesign
- [ ] Remove-PnPListItem
- [ ] Remove-PnPListItemComment
- [ ] Remove-PnPMicrosoft365Group
- [ ] Remove-PnPMicrosoft365GroupMember
- [ ] Remove-PnPMicrosoft365GroupOwner
- [ ] Remove-PnPMicrosoft365GroupSettings
- [ ] Remove-PnPNavigationNode
- [ ] Remove-PnPPage
- [ ] Remove-PnPPublishingImageRendition
- [ ] Remove-PnPSiteGroup
- [ ] Remove-PnPStorageEntity
- [ ] Remove-PnPTeamsApp
- [ ] Remove-PnPTeamsChannel
- [ ] Remove-PnPTeamsChannelUser
- [ ] Remove-PnPTeamsTab
- [ ] Remove-PnPTeamsUser
- [ ] Remove-PnPView
- [ ] Remove-PnPVivaConnectionsDashboardACE
- [ ] Remove-PnPWebhookSubscription
- [ ] Remove-PnPWebPart
- [ ] Rename-PnPFile
- [ ] Rename-PnPFolder
- [ ] Request-PnPReIndexList
- [ ] Reset-PnPFileVersion
- [ ] Reset-PnPMicrosoft365GroupExpiration
- [ ] Restore-PnPDeletedMicrosoft365Group
- [ ] Revoke-PnPHubSiteRights
- [ ] Save-PnPSiteTemplate
- [ ] Send-PnPMail
- [ ] Set-PnPAppSideLoading
- [ ] Set-PnPAuditing
- [ ] Set-PnPDefaultContentTypeToList
- [ ] Set-PnPDefaultPageLayout
- [ ] Set-PnPDocumentSetField
- [ ] Set-PnPField
- [ ] Set-PnPFileCheckedOut
- [ ] Set-PnPGraphSubscription
- [ ] Set-PnPHomePage
- [ ] Set-PnPHomeSite
- [ ] Set-PnPKnowledgeHubSite
- [ ] Set-PnPListItem
- [ ] Set-PnPListItemAsRecord
- [ ] Set-PnPListItemPermission
- [ ] Set-PnPMessageCenterAnnouncementAsArchived
- [ ] Set-PnPMessageCenterAnnouncementAsFavorite
- [ ] Set-PnPMessageCenterAnnouncementAsNotArchived
- [ ] Set-PnPMessageCenterAnnouncementAsNotFavorite
- [ ] Set-PnPMessageCenterAnnouncementAsRead
- [ ] Set-PnPMicrosoft365Group
- [ ] Set-PnPMicrosoft365GroupSettings
- [ ] Set-PnPSearchSettings
- [ ] Set-PnPSite
- [ ] Set-PnPSiteClosure
- [ ] Set-PnPSiteDesign
- [ ] Set-PnPSitePolicy
- [ ] Set-PnPSiteScriptPackage
- [ ] Set-PnPSiteTemplateMetadata
- [ ] Set-PnPStorageEntity
- [ ] Set-PnPTaxonomyFieldValue
- [ ] Set-PnPTeamsChannel
- [ ] Set-PnPTeamsChannelUser
- [ ] Set-PnPTeamsTab
- [ ] Set-PnPTeamsTeam
- [ ] Set-PnPTeamsTeamArchivedState
- [ ] Set-PnPTemporarilyDisableAppBar
- [ ] Set-PnPWebhookSubscription
- [ ] Set-PnPWebPartProperty
- [ ] Submit-PnPSearchQuery
- [ ] Submit-PnPTeamsChannelMessage
- [ ] Sync-PnPAppToTeams
- [ ] Test-PnPListItemIsRecord
- [ ] Test-PnPTenantTemplate
- [ ] Uninstall-PnPApp
- [ ] Unpublish-PnPApp
- [ ] Unpublish-PnPContentType
- [ ] Unregister-PnPHubSite
- [ ] Update-PnPApp
- [ ] Update-PnPTeamsApp
- [ ] Update-PnPVivaConnectionsDashboardACE
π Progess
progess may be tracked π https://github.com/Adam-it/powershell/tree/docs-fixes-part-2
if you agree on that proposal, I will be more than happy to resolve this issue π
hi @Adam-it , thank you so much for looking into this. Totally welcome your help on this issue π
hi @Adam-it , thank you so much for looking into this. Totally welcome your help on this issue π
Great π. I will start working on this over the week π
hi @Adam-it , thank you so much for looking into this. Totally welcome your help on this issue π
Great π. I will start working on this over the week π
No pressure seriously π. We donβt have any ETA over here. Just send a PR whenever you think itβs ready. Will have a look after that.
Once merged , it will be available next day itself.
hi @Adam-it, any updates on this? No pressure :)
I checked the commits, looks quite good. Let us know if you are stuck somewhere or need anything from our end. Thanks again :)
hi @Adam-it, any updates on this? No pressure :)
I checked the commits, looks quite good. Let us know if you are stuck somewhere or need anything from our end. Thanks again :)
Thanks for reaching out. TBH all goes fine but just slow π, sorry for that π. Lately I was actively contributing in CLI and had a bunch of features to add in the vs code extensions for PnP PS and CLI. But that's all released now so this weekend I was planning to focus more on this issue π. Hope to catch up and hope to finish this off so it could be still pushed in October for Hacktoberfest π
all done π. only need to clean up (rebase) and merge with latest dev and double check if anything new did not show up that also has an error π