Skip to content

Commit

Permalink
update help content
Browse files Browse the repository at this point in the history
  • Loading branch information
metablaster committed Jan 19, 2024
1 parent 36c4f53 commit de4c342
Show file tree
Hide file tree
Showing 46 changed files with 181 additions and 89 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
Module Name: Ruleset.Compatibility
Module Guid: eb203a5b-d397-4909-9fe9-00b0f083f36a
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0
Help Version: 0.16.0
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1
Help Version: 0.16.1
Locale: en-US
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<HelpInfo xmlns="http://schemas.microsoft.com/powershell/help/2010/05">
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0</HelpContentURI>
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1</HelpContentURI>
<SupportedUICultures>
<UICulture>
<UICultureName>en-US</UICultureName>
<UICultureVersion>0.16.0</UICultureVersion>
<UICultureVersion>0.16.1</UICultureVersion>
</UICulture>
</SupportedUICultures>
</HelpInfo>
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
Module Name: Ruleset.ComputerInfo
Module Guid: c68a812d-076d-47bd-a73d-8d4600bd3c51
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0
Help Version: 0.16.0
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1
Help Version: 0.16.1
Locale: en-US
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<HelpInfo xmlns="http://schemas.microsoft.com/powershell/help/2010/05">
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0</HelpContentURI>
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1</HelpContentURI>
<SupportedUICultures>
<UICulture>
<UICultureName>en-US</UICultureName>
<UICultureVersion>0.16.0</UICultureVersion>
<UICultureVersion>0.16.1</UICultureVersion>
</UICulture>
</SupportedUICultures>
</HelpInfo>
31 changes: 21 additions & 10 deletions Modules/Ruleset.Firewall/Help/en-US/Remove-FirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,22 +179,32 @@ Build date: 2020/02/15
Changes by metablaster - August 2020:
1. Applied formatting and code style according to project rules
2. Added parameter to target specific policy store
3. Added parameter to let specify directory
4. Added more output streams for debug, verbose and info
5. Make output formatted and colored
6. Changed minor flow of execution
1.
Applied formatting and code style according to project rules
2.
Added parameter to target specific policy store
3.
Added parameter to let specify directory
4.
Added more output streams for debug, verbose and info
5.
Make output formatted and colored
6.
Changed minor flow of execution
December 2020:
1. Rename parameters according to standard name convention
2. Support resolving path wildcard pattern
1.
Rename parameters according to standard name convention
2.
Support resolving path wildcard pattern
January 2022:
1. Added time measurement code
2. Added progress bar
1.
Added time measurement code
2.
Added progress bar
TODO: implement removing rules not according to file
Expand All @@ -203,3 +213,4 @@ TODO: implement removing rules not according to file
[https://github.com/metablaster/WindowsFirewallRuleset/blob/master/Modules/Ruleset.Firewall/Help/en-US/Remove-FirewallRule.md](https://github.com/metablaster/WindowsFirewallRuleset/blob/master/Modules/Ruleset.Firewall/Help/en-US/Remove-FirewallRule.md)
[https://github.com/MScholtes/Firewall-Manager](https://github.com/MScholtes/Firewall-Manager)
4 changes: 2 additions & 2 deletions Modules/Ruleset.Firewall/Help/en-US/Ruleset.Firewall.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
Module Name: Ruleset.Firewall
Module Guid: 3ee23849-8adf-46ee-95f9-7a02417e1f4b
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0
Help Version: 0.16.0
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1
Help Version: 0.16.1
Locale: en-US
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<HelpInfo xmlns="http://schemas.microsoft.com/powershell/help/2010/05">
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0</HelpContentURI>
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1</HelpContentURI>
<SupportedUICultures>
<UICulture>
<UICultureName>en-US</UICultureName>
<UICultureVersion>0.16.0</UICultureVersion>
<UICultureVersion>0.16.1</UICultureVersion>
</UICulture>
</SupportedUICultures>
</HelpInfo>
4 changes: 2 additions & 2 deletions Modules/Ruleset.IP/Help/en-US/Ruleset.IP.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
Module Name: Ruleset.IP
Module Guid: 2f356d8c-aad0-462f-9cd7-fff31c7ab1d0
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0
Help Version: 0.16.0
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1
Help Version: 0.16.1
Locale: en-US
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<HelpInfo xmlns="http://schemas.microsoft.com/powershell/help/2010/05">
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0</HelpContentURI>
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1</HelpContentURI>
<SupportedUICultures>
<UICulture>
<UICultureName>en-US</UICultureName>
<UICultureVersion>0.16.0</UICultureVersion>
<UICultureVersion>0.16.1</UICultureVersion>
</UICulture>
</SupportedUICultures>
</HelpInfo>
3 changes: 3 additions & 0 deletions Modules/Ruleset.Initialize/Help/en-US/Initialize-Service.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,9 @@ TODO: Some services are logged as change from ex.
from Manual to Manual, but that's not change,
this will happen ie.
if restarting service.
TODO: Service 'Function Discovery Provider Host (fdPHost)' cannot be stopped due to the following error:
Cannot stop 'FDResPub' service on computer '.'.
This error indicates this script fails to recognize service status that is not in valid state to be configured
## RELATED LINKS
Expand Down
4 changes: 2 additions & 2 deletions Modules/Ruleset.Initialize/Help/en-US/Ruleset.Initialize.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
Module Name: Ruleset.Initialize
Module Guid: 41585bd3-3f4d-4669-9919-2d19c0451b73
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0
Help Version: 0.16.0
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1
Help Version: 0.16.1
Locale: en-US
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<HelpInfo xmlns="http://schemas.microsoft.com/powershell/help/2010/05">
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0</HelpContentURI>
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1</HelpContentURI>
<SupportedUICultures>
<UICulture>
<UICultureName>en-US</UICultureName>
<UICultureVersion>0.16.0</UICultureVersion>
<UICultureVersion>0.16.1</UICultureVersion>
</UICulture>
</SupportedUICultures>
</HelpInfo>
Original file line number Diff line number Diff line change
Expand Up @@ -1104,7 +1104,7 @@
<maml:alertSet>
<maml:alert>
<maml:para>This function main purpose is automated development environment setup to be able to perform quick setup on multiple computers and virtual operating systems, in cases such as frequent system restores for the purpose of testing project code for many environment scenarios that end users may have. It should be used in conjunction with the rest of a module "Ruleset.Initialize"</maml:para>
<maml:para>TODO: Some services are logged as change from ex. from Manual to Manual, but that's not change, this will happen ie. if restarting service.</maml:para>
<maml:para>TODO: Some services are logged as change from ex. from Manual to Manual, but that's not change, this will happen ie. if restarting service. TODO: Service 'Function Discovery Provider Host (fdPHost)' cannot be stopped due to the following error: Cannot stop 'FDResPub' service on computer '.'. This error indicates this script fails to recognize service status that is not in valid state to be configured</maml:para>
</maml:alert>
</maml:alertSet>
<command:examples>
Expand Down
4 changes: 2 additions & 2 deletions Modules/Ruleset.Logging/Help/en-US/Ruleset.Logging.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
Module Name: Ruleset.Logging
Module Guid: 9be5568a-a48e-4e96-a6df-90f699cf1c8a
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0
Help Version: 0.16.0
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1
Help Version: 0.16.1
Locale: en-US
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<HelpInfo xmlns="http://schemas.microsoft.com/powershell/help/2010/05">
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0</HelpContentURI>
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1</HelpContentURI>
<SupportedUICultures>
<UICulture>
<UICultureName>en-US</UICultureName>
<UICultureVersion>0.16.0</UICultureVersion>
<UICultureVersion>0.16.1</UICultureVersion>
</UICulture>
</SupportedUICultures>
</HelpInfo>
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
Module Name: Ruleset.PolicyFileEditor
Module Guid: c321c0fc-a6d8-4251-8f71-c69d8a57ce8f
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0
Help Version: 0.16.0
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1
Help Version: 0.16.1
Locale: en-US
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<HelpInfo xmlns="http://schemas.microsoft.com/powershell/help/2010/05">
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1</HelpContentURI>
<SupportedUICultures>
<UICulture>
<UICultureName>en-US</UICultureName>
<UICultureVersion>0.16.1</UICultureVersion>
</UICulture>
</SupportedUICultures>
</HelpInfo>
<HelpContentURI>https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1</HelpContentURI>
<SupportedUICultures>
<UICulture>
<UICultureName>en-US</UICultureName>
<UICultureVersion>0.16.1</UICultureVersion>
</UICulture>
</SupportedUICultures>
</HelpInfo>
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Predefined program name for which to search
Type: TargetProgram
Parameter Sets: (All)
Aliases:
Accepted values: GoogleUpdate, BlueStacks, BlueStacksServices, GooglePlay, calibre, ytdlp, Motrix, LGHUB, nmap, Brave, Psiphon, MSI, EdgeWebView, SteamCMD, Audacity, dotnet, CMake, SqlPath, SqlServer, SqlManagementStudio, WindowsDefender, NuGet, NETFramework, vcpkg, SysInternals, WindowsKits, WebPlatform, OpenSpace, XTU, Chocolatey, ArenaChess, GoogleDrive, RivaTuner, Incredibuild, ColorMania, MetaTrader, RealWorld, AzureDataStudio, qBittorrent, OpenTTD, EveOnline, DemiseOfNations, CounterStrikeGO, PinballArcade, JavaUpdate, JavaRuntime, AdobeARM, AdobeReader, AdobeAcrobat, LoLGame, FileZilla, PathOfExile, HWMonitor, CPUZ, MSIAfterburner, GPG, OBSStudio, PasswordSafe, Greenshot, DnsCrypt, OpenSSH, PowerShellCore64, PowerShell64, PowerShell86, OneDrive, HelpViewer, VSCode, MicrosoftOffice, TeamViewer, EdgeChromium, Chrome, Firefox, Yandex, Tor, uTorrent, Thuderbird, Steam, Nvidia64, Nvidia86, GeForceExperience, WarThunder, PokerStars, VisualStudio, VisualStudioInstaller, MSYS2, Git, GitHubDesktop, EpicGames, UnrealEngine, BingWallpaper
Accepted values: PowerToys, GoogleUpdate, BlueStacks, BlueStacksServices, GooglePlay, calibre, ytdlp, Motrix, LGHUB, nmap, Brave, Psiphon, MSI, EdgeWebView, SteamCMD, Audacity, dotnet, CMake, SqlPath, SqlServer, SqlManagementStudio, WindowsDefender, NuGet, NETFramework, vcpkg, SysInternals, WindowsKits, WebPlatform, OpenSpace, XTU, Chocolatey, ArenaChess, GoogleDrive, RivaTuner, Incredibuild, ColorMania, MetaTrader, RealWorld, AzureDataStudio, qBittorrent, OpenTTD, EveOnline, DemiseOfNations, CounterStrikeGO, PinballArcade, JavaUpdate, JavaRuntime, AdobeARM, AdobeReader, AdobeAcrobat, LoLGame, FileZilla, PathOfExile, HWMonitor, CPUZ, MSIAfterburner, GPG, OBSStudio, PasswordSafe, Greenshot, DnsCrypt, OpenSSH, PowerShellCore64, PowerShell64, PowerShell86, OneDrive, HelpViewer, VSCode, MicrosoftOffice, TeamViewer, EdgeChromium, Chrome, Firefox, Yandex, Tor, uTorrent, Thuderbird, Steam, Nvidia64, Nvidia86, GeForceExperience, WarThunder, PokerStars, VisualStudio, VisualStudioInstaller, MSYS2, Git, GitHubDesktop, EpicGames, UnrealEngine, BingWallpaper

Required: True
Position: 1
Expand Down
8 changes: 5 additions & 3 deletions Modules/Ruleset.ProgramInfo/Help/en-US/Get-SystemApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ Get store apps installed system wide
### Domain (Default)

```powershell
Get-SystemApp [[-Name] <String>] -User <String> [-Domain <String>] [-Credential <PSCredential>]
Get-SystemApp [[-Name] <String>] [-User <String>] [-Domain <String>] [-Credential <PSCredential>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### Session

```powershell
Get-SystemApp [[-Name] <String>] -User <String> [-Session <PSSession>] [-ProgressAction <ActionPreference>]
Get-SystemApp [[-Name] <String>] [-User <String>] [-Session <PSSession>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

Expand Down Expand Up @@ -74,12 +74,14 @@ User name in form of:
- user_name
- SID-string
If not specified gets store apps for all user accounts on the computer
```yaml
Type: System.String
Parameter Sets: (All)
Aliases: UserName

Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,5 +85,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
We should return empty PSCustomObject if test computer fails
TODO: Parameter for x64 vs x86 software, then update Search-Installation switch as needed
TODO: One of the entries is blank program name leading to %SystemRoot%\System32
## RELATED LINKS
8 changes: 5 additions & 3 deletions Modules/Ruleset.ProgramInfo/Help/en-US/Get-UserApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ Get store apps for specific user
### Domain (Default)

```powershell
Get-UserApp [[-Name] <String>] -User <String> [-Domain <String>] [-Credential <PSCredential>]
Get-UserApp [[-Name] <String>] [-User <String>] [-Domain <String>] [-Credential <PSCredential>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### Session

```powershell
Get-UserApp [[-Name] <String>] -User <String> [-Session <PSSession>] [-ProgressAction <ActionPreference>]
Get-UserApp [[-Name] <String>] [-User <String>] [-Session <PSSession>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

Expand Down Expand Up @@ -74,12 +74,14 @@ User name in form of:
- user_name
- SID-string
If not specified gets store apps for all user accounts on the computer
```yaml
Type: System.String
Parameter Sets: (All)
Aliases: UserName

Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Expand Down
4 changes: 2 additions & 2 deletions Modules/Ruleset.ProgramInfo/Help/en-US/Ruleset.ProgramInfo.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
Module Name: Ruleset.ProgramInfo
Module Guid: 49f11777-b8b6-4fed-bd82-32c8f48db81e
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.0
Help Version: 0.16.0
Download Help Link: https://github.com/metablaster/WindowsFirewallRuleset/tree/master/Config/HelpContent/0.16.1
Help Version: 0.16.1
Locale: en-US
---

Expand Down
5 changes: 3 additions & 2 deletions Modules/Ruleset.ProgramInfo/Help/en-US/Search-Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Predefined program name
Type: TargetProgram
Parameter Sets: (All)
Aliases: Program
Accepted values: GoogleUpdate, BlueStacks, BlueStacksServices, GooglePlay, calibre, ytdlp, Motrix, LGHUB, nmap, Brave, Psiphon, MSI, EdgeWebView, SteamCMD, Audacity, dotnet, CMake, SqlPath, SqlServer, SqlManagementStudio, WindowsDefender, NuGet, NETFramework, vcpkg, SysInternals, WindowsKits, WebPlatform, OpenSpace, XTU, Chocolatey, ArenaChess, GoogleDrive, RivaTuner, Incredibuild, ColorMania, MetaTrader, RealWorld, AzureDataStudio, qBittorrent, OpenTTD, EveOnline, DemiseOfNations, CounterStrikeGO, PinballArcade, JavaUpdate, JavaRuntime, AdobeARM, AdobeReader, AdobeAcrobat, LoLGame, FileZilla, PathOfExile, HWMonitor, CPUZ, MSIAfterburner, GPG, OBSStudio, PasswordSafe, Greenshot, DnsCrypt, OpenSSH, PowerShellCore64, PowerShell64, PowerShell86, OneDrive, HelpViewer, VSCode, MicrosoftOffice, TeamViewer, EdgeChromium, Chrome, Firefox, Yandex, Tor, uTorrent, Thuderbird, Steam, Nvidia64, Nvidia86, GeForceExperience, WarThunder, PokerStars, VisualStudio, VisualStudioInstaller, MSYS2, Git, GitHubDesktop, EpicGames, UnrealEngine, BingWallpaper
Accepted values: PowerToys, GoogleUpdate, BlueStacks, BlueStacksServices, GooglePlay, calibre, ytdlp, Motrix, LGHUB, nmap, Brave, Psiphon, MSI, EdgeWebView, SteamCMD, Audacity, dotnet, CMake, SqlPath, SqlServer, SqlManagementStudio, WindowsDefender, NuGet, NETFramework, vcpkg, SysInternals, WindowsKits, WebPlatform, OpenSpace, XTU, Chocolatey, ArenaChess, GoogleDrive, RivaTuner, Incredibuild, ColorMania, MetaTrader, RealWorld, AzureDataStudio, qBittorrent, OpenTTD, EveOnline, DemiseOfNations, CounterStrikeGO, PinballArcade, JavaUpdate, JavaRuntime, AdobeARM, AdobeReader, AdobeAcrobat, LoLGame, FileZilla, PathOfExile, HWMonitor, CPUZ, MSIAfterburner, GPG, OBSStudio, PasswordSafe, Greenshot, DnsCrypt, OpenSSH, PowerShellCore64, PowerShell64, PowerShell86, OneDrive, HelpViewer, VSCode, MicrosoftOffice, TeamViewer, EdgeChromium, Chrome, Firefox, Yandex, Tor, uTorrent, Thuderbird, Steam, Nvidia64, Nvidia86, GeForceExperience, WarThunder, PokerStars, VisualStudio, VisualStudioInstaller, MSYS2, Git, GitHubDesktop, EpicGames, UnrealEngine, BingWallpaper

Required: True
Position: 1
Expand Down Expand Up @@ -195,6 +195,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES
None.
TODO: Search string for Update-Table -Search contains * on both side, this need to be more
restrictive to avoid duplicate matches or misses.
## RELATED LINKS
Loading

0 comments on commit de4c342

Please sign in to comment.