Move SPO-PS info from sp-dev-docs page to separate reference topics #361
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 5 commits
March 6, 2018 11:22
Added items from TOC list that were missing on this page
Needs a review by Vesa
Changed example text from "The following example..." to "This example..."
❌ Validation status: errors
sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md
skype/skype-ps/skype/Get-CsPoolFabricState.md
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. |
❌ Validation status: errors
sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md
skype/skype-ps/skype/Get-CsPoolFabricState.md
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. |
❌ Validation status: errors
sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md
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. |
❌ Validation status: errors
sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md
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. |
❌ Validation status: errors
sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md
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. |
Also moved EXAMPLES sections above PARAMETERS section in sharepoint online
❌ Validation status: errors
sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md
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. |
❌ Validation status: errors
sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md
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. |
added 2 commits
March 13, 2018 14:13
Set-SPOSiteScript.md
Just copied SYNOPSIS for now
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md | View (sharepoint-ps) | Details | |
| sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md | View (sharepoint-ps) | Details | |
| sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md | View (sharepoint-ps) | Details | |
| exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Get-AdministrativeUnit.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Get-ConnectionByClientTypeReport.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Get-OfflineAddressBook.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-ActivityAlert.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-AntiPhishRule.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-ClientAccessRule.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-EmailAddressPolicy.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-InboundConnector.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-OabVirtualDirectory.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-OutboundConnector.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-RoleGroup.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-SendConnector.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-SystemMessage.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-TransportRule.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-UnifiedGroup.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Search-AdminAuditLog.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-AcceptedDomain.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-ActivityAlert.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-CASMailbox.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-ClientAccessRule.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-EventLogLevel.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-InboundConnector.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-MailboxSearch.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-OfflineAddressBook.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Set-OutboundConnector.md | ✅Succeeded | ||
| exchange/exchange-ps/exchange/Test-ExchangeUMCallFlow.md | ✅Succeeded | ||
| sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOService.md | ✅Succeeded | View (sharepoint-ps) | |
| sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md | ✅Succeeded | View (sharepoint-ps) | |
| sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md | ✅Succeeded | View (sharepoint-ps) | |
| sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesign.md | ✅Succeeded | View (sharepoint-ps) |
This comment lists only the first 50 files in the pull request.
sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md
- [Warning] Invalid file link:(~/sharepoint-ps/sharepoint-online/customize-default-site-design.md).
sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md
- [Warning] Invalid file link:(~/sharepoint-ps/sharepoint-online/site-design-json-schema.md).
sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md
- [Warning] Invalid file link:(~/sharepoint-ps/sharepoint-online/customize-default-site-design.md).
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.
| A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](customize-default-site-design.md). | ||
|
|
||
| ```yaml | ||
| Type: CommonParameters |
Contributor
There was a problem hiding this comment.
Type is SwitchParameter (always used on switches like this.)
| An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. | ||
|
|
||
| ```yaml | ||
| Type: SPOSiteScriptPipeBind |
Contributor
There was a problem hiding this comment.
Should be "SPOSiteScriptPipeBind[]" since this is an array
| This example creates a new site design. | ||
|
|
||
| ```powershell | ||
| C:\> Add-SPOSiteDesign ` |
Contributor
There was a problem hiding this comment.
Remove the "C:>" prompts. Makes it easier for PowerShell devs to copy paste the code.
Author
There was a problem hiding this comment.
Updated all instances of C: throughout docs
| ``` | ||
|
|
||
| ```powershell | ||
| C:\> Get-Content 'c:\scripts\site-script.json' -Raw | Add-SPOSiteScript -Title "Customer logo" -Description "Applies customer logo for customer sites" |
| This example and sample response show how to get site design details. | ||
|
|
||
| ```powershell | ||
| PS C:\> Get-SPOSiteDesign 44252d09-62c4-4913-9eb0-a2a8b8d7f863 |
Contributor
There was a problem hiding this comment.
Remove "PS C:>" prompt.
| One or more principles to add permissions for. | ||
|
|
||
| ```yaml | ||
| Type: String |
Contributor
There was a problem hiding this comment.
Should be "String[]" since this is an array.
| Always set to the value **View**. Any user or group with view permissions can view and use the site design. | ||
|
|
||
| ```yaml | ||
| Type: |
Contributor
There was a problem hiding this comment.
This was hard to track down, but the actual type is "SPOSiteDesignPrincipalRights"
| The ID of the site design to apply. | ||
|
|
||
| ```yaml | ||
| Type: |
Contributor
There was a problem hiding this comment.
SPOSiteDesignPipeBind
| This example applies a site design whose script creates two lists, formats several of the columns, adds the lists to the site navigation, and then joins the site to an existing hub site. | ||
|
|
||
| ```powershell | ||
| C:\> Invoke-SPOSiteDesign -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectgo” |
Contributor
There was a problem hiding this comment.
Remove the "C:>" prompt
| This example shows how to remove a site design. | ||
|
|
||
| ```powershell | ||
| C:\> Remove-SPOSiteDesign 21209d88-38de-4844-9823-f1f600a1179a |
Contributor
There was a problem hiding this comment.
Remove the "C:>" prompt.
✅ Validation status: passed
This comment lists only the first 50 files in the pull request. 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. |
Contributor
|
Answers to questions:
This all sounds good --> "On existing pages, the EXAMPLES section appears before the PARAMETERS section; on my new pages, they're reversed because that's how they appeared in the conceptual topic. Not sure if this makes a difference. - UPDATE - I switched these two sections around in all the topics." |
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` |
Contributor
There was a problem hiding this comment.
Here is an example:
Remove-SPOSiteScript 5ea28194-6fe7-4e2c-ba84-c409368278e
2
|
|
||
| ## DESCRIPTION | ||
|
|
||
| Removes a site script. <!-- TBD how is dependency problem handled so you don't delete a script that a design depends on. this currently creates an error when running the design.) --> |
Contributor
There was a problem hiding this comment.
Can remove this TBD as I followed up separately with PM on this.
|
|
||
| ## SYNOPSIS | ||
|
|
||
| Removes a site script. <!-- TBD how is dependency problem handled so you don't delete a script that a design depends on. this currently creates an error when running the design.) --> |
| One or more principals to revoke rights on the specified site design. | ||
|
|
||
| ```yaml | ||
| Type: String |
Contributor
There was a problem hiding this comment.
Should be "String[]" since this is array.
| A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/customize-default-site-design). | ||
|
|
||
| ```yaml | ||
| Type: CommonParameters |
Contributor
There was a problem hiding this comment.
This is a "SwitchParameter" type. Not CommonParameters
| An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. | ||
|
|
||
| ```yaml | ||
| Type: SPOSiteScriptPipeBind |
Contributor
There was a problem hiding this comment.
Should be "SPOSiteScriptPipeBind[]" since it is an array.
| This example shows how to get script information for a specific script ID. | ||
|
|
||
| ```powershell | ||
| PS C:\scripts> Get-SPOSiteScript 07702c07-0485-426f-b710-4704241caad9 |
Contributor
There was a problem hiding this comment.
Remove the "PS C:\scripts>" prompt
| This example gets the rights for a site design. | ||
|
|
||
| ```powershell | ||
| PS C:\> Get-SPOSiteDesignRights 607aed52-6d61-490a-b692-c0f58a6981a1 |
Contributor
There was a problem hiding this comment.
Remove the "PS C:>" prompt
| A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/customize-default-site-design). | ||
|
|
||
| ```yaml | ||
| Type: CommonParameters |
Contributor
There was a problem hiding this comment.
Type is "SwitchParameter" not CommonParameters
❌ Validation status: errors
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. |
✅ Validation status: passed
This comment lists only the first 50 files in the pull request. 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. |
added 2 commits
March 13, 2018 17:09
INPUTS, OUTPUTS, NOTES, RELATED LINKS not always rendering correctly; shouldn't show up on stage when there's nothing in them
✅ Validation status: passed
This comment lists only the first 50 files in the pull request. 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. |
Author
|
@davidchesnut I've made all the updates that you requested and looked these over on stage, and they are ready to go live. Note that I removed the extra H2s at the end of some docs because they weren't rendering correctly. After they're live, I'll add the Set-SPOSiteScript back in separately (the page that was causing all the build issues), and then I'll update the sp-dev-docs page to point to them. Can you notify the MAX team to push these live? Thanks. |
Contributor
|
It's not really Max team controlling SPO PowerShell cmdlets. We have different people for the different sections in this repositories - SPO cmdlets are controlled by me, so merging this in now. Other cmdlets are controlled by different other people, which does make this PR slightly problematic, as it modifies so many things from different areas and does not only include Site Design PowerShell documentation. |
Member
|
@Linda-Editor @VesaJuvonen - I noticed a lot of edits to files in exchange and skype too. Looking through them it looks like mostly changing things to use the [!TAG]. I just want to confirm we have checked that these tags render correctly in Get-Help in product. I believe the writers were using -Important or Important: instead of [!IMPORTANT] because we haven't confirmed how Get-Help will render this tag. |
Author
|
Yes, they are rendering correctly, at least in sharepoint. See this topic: https://docs.microsoft.com/en-us/powershell/module/sharepoint-online/set-spotenantsyncclientrestriction?view=sharepoint-ps |
Member
|
@Linda-Editor - not on docs.microsoft.com. In the product in Get-Help. |
Author
|
@kenwith No, I did not test it there. If you determine that it's not working there, I can revert the changes. |
Author
|
@kenwith @VesaJuvonen By the way, I'm trying to add in one more topic that was causing build issues last time, and I'm not getting a build report. The topic is showing up in my fork of the repo: Set-SPOSiteScript. Any ideas why it's not building? https://github.com/Linda-Editor/office-docs-powershell/blob/master/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md |
Member
|
@VesaJuvonen - we should check Get-Help works correctly before we merge. I haven't checked this yet. |
Member
|
@Linda-Editor - did you commit to the same branch? If so I believe it should do a build on the same PR for branch. If it is a new you might need to create a new PR for that file. |
Author
|
I committed to the same fork. I'll create a PR and see if that issues a build. |
|
@Linda-Editor the notes in this article are not showing up as expected. https://docs.microsoft.com/en-us/powershell/module/sharepoint-online/get-spotenantserviceprincipalpermissionrequests?view=sharepoint-ps Could you please take a look? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
12 participants
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.
The SPO site design cmdlets are documented in conceptual docs here:
PowerShell cmdlets for SharePoint site designs and site scripts
However the correct location should be in the cmdlet reference, like this topic:
Add-SPOGeoAdministrator
I moved the information from the conceptual topic into individual reference topics for each cmdlet. I also added the new topics to the TOC page at (sharepoint-online.md). In addition, I made sure that the TOC page matched the reference TOC in the left nav (I'm guessing as new cmdlets were added previously, the TOC page was not updated).
After these new topics go live, I'll update the original conceptual topic so that it lists each cmdlet and links off to the new page for that cmdlet.
I made these changes in my fork, and now am requesting a merge so that you can review them before they go live. A few notes:
Let me know if you have any questions or need me to make further updates. Thanks.