mirror of
https://github.com/EvotecIT/GPOZaurr.git
synced 2026-08-27 10:46:49 +00:00
Add curated website docs and examples
This commit is contained in:
@@ -216,7 +216,7 @@ $commit = (& git -C $repoRoot rev-parse HEAD).Trim()
|
|||||||
$manifest = [ordered]@{
|
$manifest = [ordered]@{
|
||||||
slug = $slug
|
slug = $slug
|
||||||
name = $moduleName
|
name = $moduleName
|
||||||
description = 'GPOZaurr website artifacts for the Evotec multi-project hub.'
|
description = 'GPOZaurr helps inspect, report on, and remediate Group Policy environments with PowerShell.'
|
||||||
mode = 'hub-full'
|
mode = 'hub-full'
|
||||||
contentMode = 'hybrid'
|
contentMode = 'hybrid'
|
||||||
status = 'active'
|
status = 'active'
|
||||||
@@ -231,12 +231,12 @@ $manifest = [ordered]@{
|
|||||||
docs = $true
|
docs = $true
|
||||||
apiPowerShell = $true
|
apiPowerShell = $true
|
||||||
apiDotNet = $false
|
apiDotNet = $false
|
||||||
examples = $false
|
examples = $true
|
||||||
}
|
}
|
||||||
artifacts = [ordered]@{
|
artifacts = [ordered]@{
|
||||||
api = 'WebsiteArtifacts/apidocs'
|
api = 'WebsiteArtifacts/apidocs'
|
||||||
docs = 'Website/content/project-docs'
|
docs = 'Website/content/project-docs'
|
||||||
examples = 'Examples'
|
examples = 'content/examples'
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
title: "GPOZaurr Docs"
|
||||||
|
description: "Curated documentation workspace for GPOZaurr."
|
||||||
|
layout: "docs"
|
||||||
|
---
|
||||||
|
|
||||||
|
GPOZaurr documentation now uses the same project-scoped workspace layout as the API so you can browse without losing context.
|
||||||
|
|
||||||
|
## Start here
|
||||||
|
|
||||||
|
- [Documentation overview](/projects/gpozaurr/docs/overview/)
|
||||||
|
- [Install](/projects/gpozaurr/docs/install/)
|
||||||
|
- [Back to project overview](/projects/gpozaurr/)
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- API reference lives under [/projects/gpozaurr/api/](/projects/gpozaurr/api/).
|
||||||
|
- Example scripts remain attached to the project and can be promoted into curated walkthroughs over time.
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
---
|
||||||
|
title: "GPOZaurr Install"
|
||||||
|
description: "Installation options for GPOZaurr."
|
||||||
|
---
|
||||||
|
|
||||||
|
## PowerShell Gallery
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
Install-Module GPOZaurr -Scope CurrentUser
|
||||||
|
```
|
||||||
|
|
||||||
|
## Source checkout
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/EvotecIT/GPOZaurr.git
|
||||||
|
```
|
||||||
|
|
||||||
|
## Next steps
|
||||||
|
|
||||||
|
- Browse API: [/projects/gpozaurr/api/](/projects/gpozaurr/api/)
|
||||||
|
- Return to project overview: [/projects/gpozaurr/](/projects/gpozaurr/)
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
title: "GPOZaurr Overview"
|
||||||
|
description: "Overview for GPOZaurr on Evotec website."
|
||||||
|
---
|
||||||
|
|
||||||
|
GPOZaurr is a PowerShell module for Group Policy diagnostics, analysis, and remediation workflows.
|
||||||
|
|
||||||
|
## What to use here
|
||||||
|
|
||||||
|
- Use this Docs area for curated onboarding and operational guidance.
|
||||||
|
- Use the API tab for cmdlet reference generated from project API artifacts.
|
||||||
|
- Use the project overview as the landing page for curated workflows until dedicated examples are published.
|
||||||
|
|
||||||
|
## Quick links
|
||||||
|
|
||||||
|
- Project overview: [/projects/gpozaurr/](/projects/gpozaurr/)
|
||||||
|
- API tab: [/projects/gpozaurr/api/](/projects/gpozaurr/api/)
|
||||||
|
- Source repository: [EvotecIT/GPOZaurr](https://github.com/EvotecIT/GPOZaurr)
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
title: "GPOZaurr Examples"
|
||||||
|
description: "Curated examples for common Group Policy administration and cleanup workflows."
|
||||||
|
layout: docs
|
||||||
|
---
|
||||||
|
|
||||||
|
These examples are maintained with the GPOZaurr repository and chosen for the website because they explain a real administrative workflow.
|
||||||
|
|
||||||
|
## Featured examples
|
||||||
|
|
||||||
|
<div class="ev-example-card-grid">
|
||||||
|
<a class="ev-example-card" href="./backup-disabled-or-empty-gpos/">
|
||||||
|
<span class="ev-example-card__eyebrow">Safe cleanup</span>
|
||||||
|
<h3>Back up disabled or empty GPOs</h3>
|
||||||
|
<p>Create a focused backup set before removing stale Group Policy Objects.</p>
|
||||||
|
</a>
|
||||||
|
<a class="ev-example-card" href="./find-group-policy-permission-issues/">
|
||||||
|
<span class="ev-example-card__eyebrow">Permission review</span>
|
||||||
|
<h3>Find Group Policy permission issues</h3>
|
||||||
|
<p>List permission problems that should be reviewed before remediation work starts.</p>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
title: "Back up disabled or empty GPOs"
|
||||||
|
description: "Back up selected Group Policy Objects and verify the resulting backup set."
|
||||||
|
layout: docs
|
||||||
|
---
|
||||||
|
|
||||||
|
This example shows a practical starting point for cleaning up or reviewing older Group Policy environments before deeper remediation work.
|
||||||
|
|
||||||
|
It comes from the source example at `Examples/Example-01-BackupGPOs.ps1`.
|
||||||
|
|
||||||
|
## When to use this pattern
|
||||||
|
|
||||||
|
- You want to back up stale or disabled GPOs before any cleanup work.
|
||||||
|
- You need a quick inventory of what was actually exported.
|
||||||
|
- You want a repeatable backup step before broader Group Policy review.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
Import-Module "$PSScriptRoot\..\GPoZaurr.psd1" -Force
|
||||||
|
|
||||||
|
$GPOSummary = Backup-GPOZaurr `
|
||||||
|
-BackupPath "$Env:UserProfile\Desktop\GPO" `
|
||||||
|
-Verbose `
|
||||||
|
-Type Disabled, Empty `
|
||||||
|
-IncludeDomains 'ad.evotec.pl'
|
||||||
|
|
||||||
|
$GPOSummary | Format-Table -AutoSize
|
||||||
|
|
||||||
|
if ($GPOSummary) {
|
||||||
|
Get-GPOZaurrBackupInformation -BackupFolder $GPOSummary[0].BackupDirectory | Format-Table -AutoSize
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## What this demonstrates
|
||||||
|
|
||||||
|
- targeted GPO backup instead of exporting everything blindly
|
||||||
|
- focusing on disabled or empty policies first
|
||||||
|
- validating the produced backup set after the export
|
||||||
|
|
||||||
|
## Source
|
||||||
|
|
||||||
|
- [Example-01-BackupGPOs.ps1](https://github.com/EvotecIT/GPOZaurr/blob/master/Examples/Example-01-BackupGPOs.ps1)
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
title: "Find Group Policy permission issues"
|
||||||
|
description: "Use GPOZaurr to list permission problems that should be reviewed before cleanup or remediation."
|
||||||
|
layout: docs
|
||||||
|
---
|
||||||
|
|
||||||
|
This example is a practical first pass for environments where Group Policy permissions have changed over time and nobody is fully sure what still matches the intended model.
|
||||||
|
|
||||||
|
It comes from the source example at `Examples/Example-08-ListingPermissionIssues.ps1`.
|
||||||
|
|
||||||
|
## When to use this pattern
|
||||||
|
|
||||||
|
- You want to identify GPO permission problems before making changes.
|
||||||
|
- You need evidence for a cleanup or remediation plan.
|
||||||
|
- You want a small, repeatable report that can be reviewed by the directory operations team.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
Import-Module "$PSScriptRoot\..\GPoZaurr.psd1" -Force
|
||||||
|
|
||||||
|
$Issues = Get-GPOZaurrPermissionIssue
|
||||||
|
$Issues | Format-Table -AutoSize
|
||||||
|
```
|
||||||
|
|
||||||
|
## What this demonstrates
|
||||||
|
|
||||||
|
- separating discovery from remediation
|
||||||
|
- getting a reviewable list of permission issues
|
||||||
|
- creating a safer starting point for Group Policy cleanup
|
||||||
|
|
||||||
|
## Source
|
||||||
|
|
||||||
|
- [Example-08-ListingPermissionIssues.ps1](https://github.com/EvotecIT/GPOZaurr/blob/master/Examples/Example-08-ListingPermissionIssues.ps1)
|
||||||
Reference in New Issue
Block a user