Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
85d6ab8
refactor(docs): move `Examples` directory to `pages\examples`
angrycuban13 Apr 12, 2025
964e7f5
refactor(docs): move `Function Help` directory to `pages\function_help`
angrycuban13 Apr 12, 2025
ae59ad0
refactor(docs): move `Examples` directory to `pages\examples`
angrycuban13 Apr 12, 2025
b154d9e
refactor(docs): move `Multiple Configurations.md` to `pages\examples…
angrycuban13 Apr 12, 2025
9b906b7
refactor(docs): split `Initial Setup.md` into `pages\module_installat…
angrycuban13 Apr 12, 2025
4d11f47
refactor(docs): improve formatting in `index.md`
angrycuban13 Apr 12, 2025
c7ad0ab
feat(docs): add navigation configuration in `.nav.yml`
angrycuban13 Apr 12, 2025
4b225db
fix(docs): ensure newline at end of `.nav.yml` for proper formatting
angrycuban13 Apr 12, 2025
aec2317
refactor(assets): move icons under `assets/icons`
angrycuban13 Apr 12, 2025
a46e5b1
refactor(manifest): update icon paths to use the correct assets direc…
angrycuban13 Apr 12, 2025
bcfa561
refactor(styles): enhance styling css
angrycuban13 Apr 12, 2025
86828ed
feat(config): enhance mkdocs.yml with modern features and improved or…
angrycuban13 Apr 12, 2025
1523978
refactor(docs): break up `module_installtion.md` into its own individ…
angrycuban13 Apr 13, 2025
3dd6fdf
refactor(docs): rename multiple_configurations.md
angrycuban13 Apr 13, 2025
908a558
refactor(docs): split `initial_configuration.md`
angrycuban13 Apr 13, 2025
568f9f5
refactor(docs): remove `installation.md` as part of documentation res…
angrycuban13 Apr 13, 2025
aed7b0c
refactor(docs): reorganize navigation structure
angrycuban13 Apr 13, 2025
b2c6f4f
refactor(docs): add detailed description to the About section
angrycuban13 Apr 13, 2025
f25a4b0
refactor(docs): add assets
angrycuban13 Apr 13, 2025
5dae514
refactor(docs): fix markdown formatting in contributing
angrycuban13 Apr 13, 2025
2c0f0a7
refactor(docs): fix markdown formatting in contributing
angrycuban13 Apr 13, 2025
64bb13b
refactor(docs): update documentation links
angrycuban13 Apr 13, 2025
79ef17d
refactor(docs): remove Codacy badge
angrycuban13 Apr 13, 2025
bf578e3
refactor(css): add line wrapping for code blocks
angrycuban13 Apr 13, 2025
4ac1ae5
refactor(docs): update directory structure
angrycuban13 Apr 13, 2025
8eb6c3e
refactor(docs): split `managing_users.md`
angrycuban13 Apr 13, 2025
ba0e09f
refactor(mkdocs): readd `pymdownx.tabbed`
angrycuban13 Apr 13, 2025
25afa4e
refactor(docs): reorganize navigation structure
angrycuban13 Apr 13, 2025
443ba09
refactor(docs): update `README.md`
angrycuban13 Apr 13, 2025
3e697b7
feat(docs): add `requirements.txt`
angrycuban13 Apr 14, 2025
162e569
refactor(docs): update contributing guidelines
angrycuban13 Apr 14, 2025
3786869
fix(requirements): add missing newline at end of file
angrycuban13 Apr 14, 2025
3db50b8
Trigger CI
jgeron-suhsd May 16, 2025
eef3c71
Trigger CI
jgeron-suhsd May 16, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
219 changes: 85 additions & 134 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

74 changes: 34 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,55 @@
# PSGSuite

## IMPORTANT - PSGSUITE 3.0.0+ REQUIRES POWERSHELL 7.4+

This is a breaking change introduced with PSGSuite 3.0.0. Please see the
> [!CAUTION]
>
> PSGSuite 3.0.0 and later **requires** Powershell 7.4 or newer
>
> This is a breaking change introduced with PSGSuite 3.0.0. Please see the
[CHANGELOG](./CHANGELOG.md) for more information.

---
***

<div align="center">
<!-- Discord -->
<a href="https://discord.gg/G66zVG7">
<img src="https://img.shields.io/discord/235574673155293194.svg?style=flat&label=Discord&logo=discord&color=purple"
alt="Discord - Chat" title="Discord - Chat" />
</a>&nbsp;&nbsp;&nbsp;&nbsp;
<!-- Slack -->
<a href="https://scrthq-slack-invite.herokuapp.com/">
<img src="https://img.shields.io/badge/chat-on%20slack-orange.svg?style=flat&logo=slack"
alt="Slack - Chat" title="Slack - Chat" />
</a>
<br />
<br />
<!-- PS Gallery -->
<a href="https://www.PowerShellGallery.com/packages/PSGSuite">
<img src="https://img.shields.io/powershellgallery/dt/PSGSuite.svg?style=flat&logo=powershell&color=blue"
alt="PowerShell Gallery" title="PowerShell Gallery" />
</a>&nbsp;&nbsp;&nbsp;&nbsp;
<!-- GitHub Releases -->
<a href="https://github.com/scrthq/PSGSuite/releases/latest">
<img src="https://img.shields.io/github/downloads/scrthq/PSGSuite/total.svg?logo=github&color=blue"
alt="GitHub Releases" title="GitHub Releases" />
</a>&nbsp;&nbsp;&nbsp;&nbsp;
<!-- GitHub Releases -->
<a href="https://github.com/scrthq/PSGSuite/releases/latest">
<img src="https://img.shields.io/github/release/scrthq/PSGSuite.svg?label=version&logo=github"
alt="GitHub Releases" title="GitHub Releases" />
</a>
<!-- Discord -->
<a href="https://discord.gg/G66zVG7">
<img src="https://img.shields.io/discord/235574673155293194.svg?style=flat&label=Discord&logo=discord&color=purple"
alt="Discord - Chat" title="Discord - Chat" />
</a>&nbsp;&nbsp;&nbsp;&nbsp;
<!-- Slack -->
<a href="https://scrthq-slack-invite.herokuapp.com/">
<img src="https://img.shields.io/badge/chat-on%20slack-orange.svg?style=flat&logo=slack" alt="Slack - Chat"
title="Slack - Chat" />
</a>
<br />
<br />
<!-- PS Gallery -->
<a href="https://www.PowerShellGallery.com/packages/PSGSuite">
<img src="https://img.shields.io/powershellgallery/dt/PSGSuite.svg?style=flat&logo=powershell&color=blue"
alt="PowerShell Gallery" title="PowerShell Gallery" />
</a>&nbsp;&nbsp;&nbsp;&nbsp;
<!-- GitHub Releases -->
<a href="https://github.com/scrthq/PSGSuite/releases/latest">
<img src="https://img.shields.io/github/downloads/scrthq/PSGSuite/total.svg?logo=github&color=blue"
alt="GitHub Releases" title="GitHub Releases" />
</a>&nbsp;&nbsp;&nbsp;&nbsp;
<!-- GitHub Releases -->
<a href="https://github.com/scrthq/PSGSuite/releases/latest">
<img src="https://img.shields.io/github/release/scrthq/PSGSuite.svg?label=version&logo=github"
alt="GitHub Releases" title="GitHub Releases" />
</a>
</div>
<br />

***

## Documentation

Check out [PSGSuite.io](https://psgsuite.io/) for PSGSuite documentation, including [initial setup](https://psgsuite.io/Initial%20Setup/) help as well as function help!
Check out [PSGSuite.io](https://psgsuite.io/) for PSGSuite documentation, including [configuration](https://psgsuite.io/pages/configuration) help as well as function help!

## Contributing

Interested in helping out with PSGSuite development? Please check out our [Contribution Guidelines](https://github.com/scrthq/PSGSuite/blob/main/CONTRIBUTING.md)!

Building the module locally to test changes is as easy as running the `build.ps1` file in the root of the repo. This will compile the module with your changes and import the newly compiled module at the end by default.

Want to run the Pester tests locally? Pass `Test` as the value to the `Task` script parameter like so:

```powershell
.\build.ps1 -Task Test
```

## Code of Conduct

Please adhere to our [Code of Conduct](https://github.com/scrthq/PSGSuite/blob/main/CODE_OF_CONDUCT.md) when interacting with this repo.
Expand Down
16 changes: 16 additions & 0 deletions docs/.nav.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
nav:
- PSGSuite: index.md
- Installation:
- Overview: pages/installation/overview.md
- Powershell Gallery: pages/installation/powershell_gallery.md
- GitHub Releases: pages/installation/github_releases.md
- Building From Source: pages/installation/building_from_source.md
- Configuration:
- Google Cloud: pages/configuration/google_cloud_configuration.md
- Module Configuration: pages/configuration/module_configuration.md
- Examples:
- User Management: pages/examples/user_management.md
- License Management: pages/examples/license_management.md
- Custom Schema Management: pages/examples/custom_schemas_management.md
- Multi-Use Configuration: pages/examples/multi_use_configuration.md
- Function Help: pages/function_help
Loading
Loading