Skip to content

Commit d539aed

Browse files
nsshommonsshommo
committed
Added Notes and Related Links
1 parent 363a999 commit d539aed

10 files changed

+115
-86
lines changed

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

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ schema: 2.0.0
1010
# Add-StaffHubMember
1111

1212
## SYNOPSIS
13-
Note: This cmdlet currently is in Beta.
1413
Adds a member or manager to the specified team
1514

15+
Note: This cmdlet currently is in Beta.
16+
1617
## SYNTAX
1718

1819
```
@@ -21,21 +22,21 @@ Add-StaffHubMember [-TeamId] <String> [-FirstName] <String> [-LastName] <String>
2122
```
2223

2324
## DESCRIPTION
24-
Adds a member or manager to the specified team
25+
Adds a member or manager to the specified team.
2526

2627
## EXAMPLES
2728

28-
### Example 1
29+
### -------------------------- Example 1 --------------------------
2930
```
3031
Add-StaffHubMember -TeamId "TEAM_1234" -FirstName "Abc" -LastName "123" -Email "[email protected]" -IsManager $false
3132
```
3233

33-
Adds the member with specified email/PhoneNumber to the team. Either PhoneNumber/Email is mandatory
34+
Adds the member with specified email/PhoneNumber to the team. Either PhoneNumber/Email is mandatory.
3435

3536
## PARAMETERS
3637

3738
### -Email
38-
Office 365 email of the member to be added
39+
Office 365 email of the member to be added.
3940

4041
```yaml
4142
Type: String
@@ -50,7 +51,7 @@ Accept wildcard characters: False
5051
```
5152
5253
### -FirstName
53-
First name of the member to be added
54+
First name of the member to be added.
5455
5556
```yaml
5657
Type: String
@@ -80,7 +81,7 @@ Accept wildcard characters: False
8081
```
8182
8283
### -LastName
83-
Last name of the member to be added
84+
Last name of the member to be added.
8485
8586
```yaml
8687
Type: String
@@ -95,7 +96,7 @@ Accept wildcard characters: False
9596
```
9697
9798
### -PhoneNumber
98-
Phone number of the member to be added
99+
Phone number of the member to be added.
99100
100101
```yaml
101102
Type: String
@@ -110,7 +111,7 @@ Accept wildcard characters: False
110111
```
111112
112113
### -TeamId
113-
ID of the team to which the member is to be added
114+
ID of the team to which the member is to be added.
114115
115116
```yaml
116117
Type: String
@@ -128,12 +129,14 @@ Accept wildcard characters: False
128129
129130
### None
130131
131-
132132
## OUTPUTS
133133
134134
### System.Object
135135
136136
## NOTES
137137
138+
This cmdlet currently is in Beta.
139+
138140
## RELATED LINKS
139141
142+
[Online Version](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha)

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

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ schema: 2.0.0
1010
# Add-StaffHubShift
1111

1212
## SYNOPSIS
13-
Note: This cmdlet is currently in Beta.
1413
Adds a shift to the specified member in a team.
1514

15+
Note: This cmdlet is currently in Beta.
16+
1617
## SYNTAX
1718

1819
```
@@ -21,23 +22,23 @@ Add-StaffHubShift [-Title] <String> [[-Notes] <String>] [-StartDateTime] <DateTi
2122
```
2223

2324
## DESCRIPTION
24-
Adds a shift to the specified member in a team
25+
Adds a shift to the specified member in a team.
2526

2627
## EXAMPLES
2728

28-
### Example 1
29+
### -------------------------- Example 1 --------------------------
2930
```
3031
$startTime = Get-Date -Date "2018-01-01T00:10:00"
3132
$endTime = Get-Date -Date "2018-01-01T04:10:00"
3233
Add-StaffHubShift -Title "Title" -StartDateTime $startTime -EndDateTime $endTime -ShiftType Working -MemberId "MBER_1234" -TeamId "TEAM_1234"
3334
```
3435

35-
Creates a shift for member MBER_1234 under the team TEAM_1234
36+
Creates a shift for member MBER_1234 under the team TEAM_1234.
3637

3738
## PARAMETERS
3839

3940
### -EndDateTime
40-
End time of the shift
41+
End time of the shift.
4142

4243
```yaml
4344
Type: DateTime
@@ -52,7 +53,7 @@ Accept wildcard characters: False
5253
```
5354
5455
### -MemberId
55-
Member to which the shift is to be added
56+
Member to which the shift is to be added.
5657
5758
```yaml
5859
Type: String
@@ -67,7 +68,7 @@ Accept wildcard characters: False
6768
```
6869
6970
### -Notes
70-
Additional notes for the shift
71+
Additional notes for the shift.
7172
7273
```yaml
7374
Type: String
@@ -82,7 +83,7 @@ Accept wildcard characters: False
8283
```
8384
8485
### -ShiftType
85-
ShiftType - Working/Absence
86+
ShiftType - Working/Absence.
8687
8788
```yaml
8889
Type: String
@@ -98,7 +99,7 @@ Accept wildcard characters: False
9899
```
99100
100101
### -StartDateTime
101-
Start time of the shift
102+
Start time of the shift.
102103
103104
```yaml
104105
Type: DateTime
@@ -113,7 +114,7 @@ Accept wildcard characters: False
113114
```
114115
115116
### -TeamId
116-
ID of the team to which the shift is to be added
117+
ID of the team to which the shift is to be added.
117118
118119
```yaml
119120
Type: String
@@ -128,7 +129,7 @@ Accept wildcard characters: False
128129
```
129130
130131
### -Title
131-
Title of the shift
132+
Title of the shift.
132133
133134
```yaml
134135
Type: String
@@ -146,12 +147,14 @@ Accept wildcard characters: False
146147
147148
### None
148149
149-
150150
## OUTPUTS
151151
152152
### System.Object
153153
154154
## NOTES
155155
156+
This cmdlet is currently in Beta.
157+
156158
## RELATED LINKS
157159
160+
[Online Version](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha)

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

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ schema: 2.0.0
1010
# Add-StaffHubTeam
1111

1212
## SYNOPSIS
13-
Note: This cmdlet is currently in Beta.
1413
Creates a team.
1514

15+
Note: This cmdlet is currently in Beta.
16+
1617
## SYNTAX
1718

1819
```
@@ -24,24 +25,24 @@ Creates a team.
2425

2526
## EXAMPLES
2627

27-
### Example 1
28+
### -------------------------- Example 1 --------------------------
2829
```
2930
Add-StaffHubTeam -Name "TeamFromCmdletTest" -TimeZone "Asia/Calcutta" -ManagerEmail "[email protected]"
3031
```
3132

32-
Creates a team with [email protected] as manager
33+
Creates a team with [email protected] as manager.
3334

34-
### Example 2
35+
### -------------------------- Example 2 --------------------------
3536
```
3637
Add-StaffHubTeam -Name "TeamFromCmdletTest" -TimeZone "Asia/Calcutta"
3738
```
3839

39-
Creates a team with the logged in user as manager
40+
Creates a team with the logged in user as manager.
4041

4142
## PARAMETERS
4243

4344
### -ManagerEmail
44-
Organizational email of the member who should be the manager of the team. If not specified, the logged in user is assigned as the manager
45+
Organizational email of the member who should be the manager of the team. If not specified, the logged in user is assigned as the manager.
4546

4647
```yaml
4748
Type: String
@@ -56,7 +57,7 @@ Accept wildcard characters: False
5657
```
5758
5859
### -Name
59-
Name of the team to be created
60+
Name of the team to be created.
6061
6162
```yaml
6263
Type: String
@@ -71,7 +72,7 @@ Accept wildcard characters: False
7172
```
7273
7374
### -TimeZone
74-
TimeZone of the team. Format - tz database
75+
TimeZone of the team. Format - tz database.
7576
Reference: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
7677
7778
```yaml
@@ -90,12 +91,14 @@ Accept wildcard characters: False
9091
9192
### None
9293
93-
9494
## OUTPUTS
9595
9696
### System.Object
9797
9898
## NOTES
9999
100+
This cmdlet is currently in Beta.
101+
100102
## RELATED LINKS
101103
104+
[Online Version](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha)

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

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,31 @@ schema: 2.0.0
1010
# Connect-StaffHub
1111

1212
## SYNOPSIS
13-
Note: The cmdlet is currently in Beta.
14-
The Connect-StaffHub cmdlet connects an authenticated account to use for Microsoft StaffHub cmdlet requests.
13+
The `Connect-StaffHub` cmdlet connects an authenticated account to use for Microsoft StaffHub cmdlet requests.
1514
You can use this authenticated account only with Microsoft StaffHub cmdlets.
1615

16+
Note: The cmdlet is currently in Beta.
17+
1718
## SYNTAX
1819

1920
```
2021
Connect-StaffHub [[-Credentials] <PSCredential>] [[-LogLocation] <String>] [[-LogHistoryInDays] <Int32>] [[-CultureInfo] <String>]
2122
```
2223

2324
## DESCRIPTION
24-
The Connect-StaffHub cmdlet connects an authenticated account. This cmdlet authenticates a user for Staff Hub.
25+
The `Connect-StaffHub` cmdlet connects an authenticated account. This cmdlet authenticates a user for Staff Hub.
2526
You can use this authenticated account only with Microsoft StaffHub cmdlets.
2627

2728
## EXAMPLES
2829

29-
### Example 1
30+
### -------------------------- Example 1 --------------------------
3031
```
3132
Connect-StaffHub -Credentials $mycreds
3233
```
3334

34-
LogIn the session with the specified credential
35+
LogIn the session with the specified credential.
3536

36-
### Example 2
37+
### -------------------------- Example 2 --------------------------
3738
```
3839
Connect-StaffHub
3940
```
@@ -43,7 +44,7 @@ Prompts to enter credentials and then Log in.
4344
## PARAMETERS
4445

4546
### -Credentials
46-
PSCredential object of the credential
47+
PSCredential object of the credential.
4748
Eg: $secpasswd = ConvertTo-SecureString "password" -AsPlainText -Force
4849
$mycreds = New-Object System.Management.Automation.PSCredential ("username", $secpasswd)
4950

@@ -60,7 +61,7 @@ Accept wildcard characters: False
6061
```
6162
6263
### -CultureInfo
63-
CultureInfo in which the message is to be displayed
64+
CultureInfo in which the message is to be displayed.
6465
6566
```yaml
6667
Type: String
@@ -75,7 +76,7 @@ Accept wildcard characters: False
7576
```
7677
7778
### -LogHistoryInDays
78-
Number of days the logs are to be persisted
79+
Number of days the logs are to be persisted.
7980
Default value is 10 days.
8081
8182
```yaml
@@ -91,7 +92,7 @@ Accept wildcard characters: False
9192
```
9293
9394
### -LogLocation
94-
Location where the logs are to be persisted in user's box
95+
Location where the logs are to be persisted in user's box.
9596
9697
```yaml
9798
Type: String
@@ -109,12 +110,14 @@ Accept wildcard characters: False
109110
110111
### None
111112
112-
113113
## OUTPUTS
114114
115115
### System.Object
116116
117117
## NOTES
118118
119+
The cmdlet is currently in Beta.
120+
119121
## RELATED LINKS
120122
123+
[Online Version](https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha)

0 commit comments

Comments
 (0)