Skip to content

Commit 516ef55

Browse files
kenwithkenwith
committed
Fixes metadata.
1 parent 1c6fe57 commit 516ef55

14 files changed

+83
-40
lines changed

‎repo_docs/NEW_CMDLETS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,30 @@
1010
- Skype for Business Online: `New-MarkdownHelp -module tmp_byivwzpq.e1k -OutputFolder .\docs`.
1111
4. Find the new cmdlet and you will see the stubbed markdown.
1212
5. Add correct metadata, see other similar cmdlets for examples.
13+
You will need to add the title and also applicable metadata for the cmdlet and also for each parameter.
14+
15+
**Example metadata at top of cmdlet:**
16+
17+
external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml
18+
Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets
19+
online version:
20+
**applicable: Microsoft StaffHub**
21+
**title: Get-StaffHubUsersForTenant**
22+
schema: 2.0.0
23+
24+
25+
**Example metadata for each parameter:**
26+
27+
Type: String
28+
Parameter Sets: (All)
29+
Aliases:
30+
**Applicable: Microsoft StaffHub**
31+
Required: False
32+
Position: 1
33+
Default value: None
34+
Accept pipeline input: False
35+
Accept wildcard characters: False
36+
1337
6. Add the correct Applicable tags to the top metadata and also the parameters for the cmdlet. See others for details.
1438
This is important since when the XML is generated to go back into the product the applicable is what is used for which content goes into which product.
1539
7. Add the cmdlet to TOC. TOC file is the name of the module.

‎staffhub/staffhub-ps/staffhub/Add-StaffHubMember.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ Office 365 email of the member to be added.
4141
```yaml
4242
Type: String
4343
Parameter Sets: (All)
44-
Aliases:
44+
Aliases:
45+
Applicable: Microsoft StaffHub
4546

4647
Required: False
4748
Position: 3
@@ -56,7 +57,8 @@ First name of the member to be added.
5657
```yaml
5758
Type: String
5859
Parameter Sets: (All)
59-
Aliases:
60+
Aliases:
61+
Applicable: Microsoft StaffHub
6062

6163
Required: True
6264
Position: 1
@@ -71,7 +73,8 @@ Should the person be added as a manager.
7173
```yaml
7274
Type: Boolean
7375
Parameter Sets: (All)
74-
Aliases:
76+
Aliases:
77+
Applicable: Microsoft StaffHub
7578

7679
Required: True
7780
Position: 5
@@ -86,7 +89,8 @@ Last name of the member to be added.
8689
```yaml
8790
Type: String
8891
Parameter Sets: (All)
89-
Aliases:
92+
Aliases:
93+
Applicable: Microsoft StaffHub
9094

9195
Required: True
9296
Position: 2
@@ -101,7 +105,8 @@ Phone number of the member to be added.
101105
```yaml
102106
Type: String
103107
Parameter Sets: (All)
104-
Aliases:
108+
Aliases:
109+
Applicable: Microsoft StaffHub
105110

106111
Required: False
107112
Position: 4
@@ -116,7 +121,8 @@ ID of the team to which the member is to be added.
116121
```yaml
117122
Type: String
118123
Parameter Sets: (All)
119-
Aliases:
124+
Aliases:
125+
Applicable: Microsoft StaffHub
120126

121127
Required: True
122128
Position: 0

‎staffhub/staffhub-ps/staffhub/Add-StaffHubShift.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ End time of the shift.
4343
```yaml
4444
Type: DateTime
4545
Parameter Sets: (All)
46-
Aliases:
47-
46+
Aliases:
47+
Applicable: Microsoft StaffHub
4848
Required: True
4949
Position: 5
5050
Default value: None
@@ -58,8 +58,8 @@ Member to which the shift is to be added.
5858
```yaml
5959
Type: String
6060
Parameter Sets: (All)
61-
Aliases:
62-
61+
Aliases:
62+
Applicable: Microsoft StaffHub
6363
Required: True
6464
Position: 1
6565
Default value: None
@@ -73,8 +73,8 @@ Additional notes for the shift.
7373
```yaml
7474
Type: String
7575
Parameter Sets: (All)
76-
Aliases:
77-
76+
Aliases:
77+
Applicable: Microsoft StaffHub
7878
Required: False
7979
Position: 3
8080
Default value: None
@@ -88,9 +88,9 @@ ShiftType - Working/Absence.
8888
```yaml
8989
Type: String
9090
Parameter Sets: (All)
91-
Aliases:
91+
Aliases:
92+
Applicable: Microsoft StaffHub
9293
Accepted values: Working, Absence
93-
9494
Required: True
9595
Position: 6
9696
Default value: None
@@ -104,8 +104,8 @@ Start time of the shift.
104104
```yaml
105105
Type: DateTime
106106
Parameter Sets: (All)
107-
Aliases:
108-
107+
Aliases:
108+
Applicable: Microsoft StaffHub
109109
Required: True
110110
Position: 4
111111
Default value: None
@@ -119,8 +119,8 @@ ID of the team to which the shift is to be added.
119119
```yaml
120120
Type: String
121121
Parameter Sets: (All)
122-
Aliases:
123-
122+
Aliases:
123+
Applicable: Microsoft StaffHub
124124
Required: True
125125
Position: 0
126126
Default value: None
@@ -134,8 +134,8 @@ Title of the shift.
134134
```yaml
135135
Type: String
136136
Parameter Sets: (All)
137-
Aliases:
138-
137+
Aliases:
138+
Applicable: Microsoft StaffHub
139139
Required: False
140140
Position: 2
141141
Default value: None

‎staffhub/staffhub-ps/staffhub/Add-StaffHubTeam.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Organizational email of the member who should be the manager of the team. If not
4848
Type: String
4949
Parameter Sets: (All)
5050
Aliases:
51-
51+
Applicable: Microsoft StaffHub
5252
Required: False
5353
Position: 2
5454
Default value: None
@@ -63,7 +63,7 @@ Name of the team to be created.
6363
Type: String
6464
Parameter Sets: (All)
6565
Aliases:
66-
66+
Applicable: Microsoft StaffHub
6767
Required: True
6868
Position: 0
6969
Default value: None
@@ -79,7 +79,7 @@ Reference: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
7979
Type: String
8080
Parameter Sets: (All)
8181
Aliases:
82-
82+
Applicable: Microsoft StaffHub
8383
Required: True
8484
Position: 1
8585
Default value: None

‎staffhub/staffhub-ps/staffhub/Connect-StaffHub.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ $mycreds = New-Object System.Management.Automation.PSCredential ("username", $se
5252
Type: PSCredential
5353
Parameter Sets: (All)
5454
Aliases:
55-
55+
Applicable: Microsoft StaffHub
5656
Required: False
5757
Position: 0
5858
Default value: None
@@ -67,7 +67,7 @@ CultureInfo in which the message is to be displayed.
6767
Type: String
6868
Parameter Sets: (All)
6969
Aliases:
70-
70+
Applicable: Microsoft StaffHub
7171
Required: False
7272
Position: 3
7373
Default value: en-US
@@ -83,7 +83,7 @@ Default value is 10 days.
8383
Type: Int32
8484
Parameter Sets: (All)
8585
Aliases:
86-
86+
Applicable: Microsoft StaffHub
8787
Required: False
8888
Position: 2
8989
Default value: 10
@@ -98,7 +98,7 @@ Location where the logs are to be persisted in user's box.
9898
Type: String
9999
Parameter Sets: (All)
100100
Aliases:
101-
101+
Applicable: Microsoft StaffHub
102102
Required: False
103103
Position: 1
104104
Default value: None

‎staffhub/staffhub-ps/staffhub/Get-StaffHubMember.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ MemberId for the specified member in the team.
4848
Type: String
4949
Parameter Sets: (All)
5050
Aliases:
51-
51+
Applicable: Microsoft StaffHub
5252
Required: False
5353
Position: 1
5454
Default value: None
@@ -63,7 +63,7 @@ TeamId for which all the members are to be fetched.
6363
Type: String
6464
Parameter Sets: (All)
6565
Aliases:
66-
66+
Applicable: Microsoft StaffHub
6767
Required: True
6868
Position: 0
6969
Default value: None

‎staffhub/staffhub-ps/staffhub/Get-StaffHubShifts.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml
33
Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets
44
online version:
5+
applicable: Microsoft StaffHub
6+
title: Get-StaffHubShifts
57
schema: 2.0.0
68
---
79

@@ -49,6 +51,7 @@ EndDateTime for the time window between which shifts are to be fetched
4951
Type: DateTime
5052
Parameter Sets: (All)
5153
Aliases:
54+
Applicable: Microsoft StaffHub
5255

5356
Required: True
5457
Position: 2
@@ -64,6 +67,7 @@ MemberId of the member for which the shifts are to be fetched
6467
Type: String
6568
Parameter Sets: (All)
6669
Aliases:
70+
Applicable: Microsoft StaffHub
6771

6872
Required: False
6973
Position: 3
@@ -79,6 +83,7 @@ StartDateTime for the time window between which shifts are to be fetched
7983
Type: DateTime
8084
Parameter Sets: (All)
8185
Aliases:
86+
Applicable: Microsoft StaffHub
8287

8388
Required: True
8489
Position: 1
@@ -94,6 +99,7 @@ TeamId of the team for which the shifts are to be fetched
9499
Type: String
95100
Parameter Sets: (All)
96101
Aliases:
102+
Applicable: Microsoft StaffHub
97103

98104
Required: True
99105
Position: 0

‎staffhub/staffhub-ps/staffhub/Get-StaffHubTeamsForTenant.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Continuation Token returned by the previous call.
5353
Type: String
5454
Parameter Sets: (All)
5555
Aliases:
56-
56+
Applicable: Microsoft StaffHub
5757
Required: False
5858
Position: 1
5959
Default value: None
@@ -68,7 +68,7 @@ Top 'n' items to be fetched sorted by ascending creation time order.
6868
Type: Int32
6969
Parameter Sets: (All)
7070
Aliases:
71-
71+
Applicable: Microsoft StaffHub
7272
Required: False
7373
Position: 0
7474
Default value: None

‎staffhub/staffhub-ps/staffhub/Get-StaffHubUsersForTenant.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml
33
Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets
44
online version:
5+
applicable: Microsoft StaffHub
6+
title: Get-StaffHubUsersForTenant
57
schema: 2.0.0
68
---
79

@@ -50,6 +52,7 @@ Continuation Token returned by the previous call
5052
Type: String
5153
Parameter Sets: (All)
5254
Aliases:
55+
Applicable: Microsoft StaffHub
5356

5457
Required: False
5558
Position: 1
@@ -65,6 +68,7 @@ Top 'n' items to be fetched sorted by ascending creation time order.
6568
Type: Int32
6669
Parameter Sets: (All)
6770
Aliases:
71+
Applicable: Microsoft StaffHub
6872

6973
Required: False
7074
Position: 0

‎staffhub/staffhub-ps/staffhub/Import-StaffHubMember.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ https://msdn.microsoft.com/en-us/library/system.text.encoding(v=vs.110).aspx - E
4646
Type: String
4747
Parameter Sets: (All)
4848
Aliases:
49-
49+
Applicable: Microsoft StaffHub
5050
Required: False
5151
Position: 1
5252
Default value: None
@@ -61,7 +61,7 @@ Location of the file.
6161
Type: String
6262
Parameter Sets: (All)
6363
Aliases:
64-
64+
Applicable: Microsoft StaffHub
6565
Required: True
6666
Position: 0
6767
Default value: None

0 commit comments

Comments
 (0)