Skip to content

Commit a57dc38

Browse files
committed
Enhance Getting Help documentation with community support and -Docs parameter
Updated the Getting Help page to provide comprehensive support resources: - Added "View Available Tasks" section documenting Invoke-psake -Docs parameter for listing tasks in build scripts - Reorganized content into clear sections: Built-in Help, Community Support, and Documentation - Added Community Support section with links to: - PowerShell Discord #psake channel - PowerShell Slack #psake channel - GitHub Discussions - Stack Overflow psake tag - GitHub Issues for bug reports - Improved PowerShell examples with cleaner output formatting - Added cross-references to Command Reference, Troubleshooting, and FAQ - Updated description frontmatter for better SEO
1 parent da13c5f commit a57dc38

File tree

1 file changed

+70
-35
lines changed

1 file changed

+70
-35
lines changed
Lines changed: 70 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,100 @@
11
---
2-
description: Learn how to get help on your psake tasks
2+
description: Learn how to get help with psake - built-in documentation and community support
33
sidebar_position: 3
44
---
55

66
# Getting Help
77

8-
You can also use the PowerShell command `Get-Help` on the `Invoke-psake`
9-
function to get more detailed help.
8+
## Built-in Help
109

11-
```powershell
12-
# First import the psake.psm1 file
10+
### View Available Tasks
1311

14-
Import-Module .\psake.psm1
12+
To see a list of all tasks defined in your psake build script, use the `-Docs` parameter:
1513

16-
Get-Help Invoke-psake -full
14+
```powershell
15+
Invoke-psake -Docs
1716
```
1817

19-
To list functions available in the psake module:
18+
This will print the current tasks list from your psake file, showing all available tasks and their descriptions.
19+
20+
### PowerShell Help System
21+
22+
You can use the PowerShell `Get-Help` command on the `Invoke-psake` function to get detailed help:
2023

2124
```powershell
22-
C:\Software\psake> Get-Command -module psake
23-
24-
CommandType Name Definition
25-
----------- ---- ----------
26-
Function Assert ...
27-
Function Exec ...
28-
Function FormatTaskName ...
29-
Function Include ...
30-
Function Invoke-psake ...
31-
Function Properties ...
32-
Function Task ...
33-
Function TaskSetup ...
34-
Function TaskTearDown ...
25+
# First import the psake module
26+
Import-Module psake
27+
28+
# View full help for Invoke-psake
29+
Get-Help Invoke-psake -Full
3530
```
3631

37-
To get example usage for individual functions in the psake PowerShell module,
38-
use Get-Help, For example:
32+
### List Available Commands
33+
34+
To see all functions available in the psake module:
3935

4036
```powershell
41-
C:\Software\psake> Get-Help Assert -examples
37+
Get-Command -Module psake
38+
39+
# Output:
40+
# CommandType Name Definition
41+
# ----------- ---- ----------
42+
# Function Assert ...
43+
# Function Exec ...
44+
# Function FormatTaskName ...
45+
# Function Include ...
46+
# Function Invoke-psake ...
47+
# Function Properties ...
48+
# Function Task ...
49+
# Function TaskSetup ...
50+
# Function TaskTearDown ...
51+
```
52+
53+
### Get Examples for Specific Commands
54+
55+
Use `Get-Help` with the `-Examples` parameter to see usage examples:
4256

43-
NAME
44-
Assert
57+
```powershell
58+
Get-Help Assert -Examples
59+
60+
# Output:
61+
# NAME
62+
# Assert
63+
#
64+
# SYNOPSIS
65+
# Helper function for "Design by Contract" assertion checking.
66+
#
67+
# -------------------------- EXAMPLE 1 --------------------------
68+
# Assert $false "This always throws an exception"
69+
#
70+
# -------------------------- EXAMPLE 2 --------------------------
71+
# Assert ( ($i % 2) -eq 0 ) "$i is not an even number"
72+
```
4573

46-
SYNOPSIS
47-
Helper function for "Design by Contract" assertion checking.
74+
## Community Support
4875

49-
-------------------------- EXAMPLE 1 --------------------------
76+
Need help with your build scripts? The psake community is here to help!
5077

51-
C:\PS>Assert $false "This always throws an exception"
78+
### Chat & Discussion
5279

80+
- **[PowerShell Discord](https://aka.ms/psdiscord)** - Join the #psake channel for real-time chat
81+
- **[PowerShell Slack](https://aka.ms/psslack)** - Join the #psake channel for team collaboration
82+
- **[GitHub Discussions](https://github.com/orgs/psake/discussions)** - For long-form questions and discussions
5383

54-
This example always throws an exception
84+
### Q&A
5585

86+
- **[Stack Overflow](https://stackoverflow.com/questions/tagged/psake)** - Search existing questions or ask new ones using the `psake` tag
5687

88+
### Report Issues
5789

90+
Found a bug or have a feature request?
5891

59-
-------------------------- EXAMPLE 2 --------------------------
92+
- **[GitHub Issues](https://github.com/psake/psake/issues)** - Report bugs or request features in the main psake repository
6093

61-
C:\PS>Assert ( ($i % 2) -eq 0 ) "%i is not an even number"
94+
## Documentation
6295

96+
For comprehensive guides and reference materials:
6397

64-
This example may throw an exception if $i is not an even number
65-
```
98+
- **[Command Reference](/docs/commands/Invoke-psake)** - Detailed documentation for all psake commands
99+
- **[Troubleshooting](/docs/troubleshooting/common-errors)** - Solutions to common problems
100+
- **[FAQ](/docs/troubleshooting/faq)** - Frequently asked questions

0 commit comments

Comments
 (0)