Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,33 @@ Get-ConfluenceSpace -Server "AtlassianPS - wiki"

You can find the full documentation on our [homepage](https://atlassianps.org/docs/AtlassianPS.Configuration) and in the console.

```powershell
# Review the help at any time!
Get-Help about_AtlassianPS.Configuration
Get-Command -Module AtlassianPS.Configuration
Get-Help Get-AtlassianServerConfiguration -Full # or any other command
```

### Contribute

Want to contribute to AtlassianPS? Great!
We appreciate [everyone](https://atlassianps.org/#people) who invests their time to make our modules the best they can be.

Check out our guidelines on [Contributing] to our modules and documentation.

## Tested on

| Configuration | Status |
| ------------- | ------ |
| Windows PowerShell v5.1 | [CI workflow](https://github.com/AtlassianPS/AtlassianPS.Configuration/actions/workflows/ci.yml) |
| PowerShell 7 on Windows | [CI workflow](https://github.com/AtlassianPS/AtlassianPS.Configuration/actions/workflows/ci.yml) |
| PowerShell 7 on Ubuntu | [CI workflow](https://github.com/AtlassianPS/AtlassianPS.Configuration/actions/workflows/ci.yml) |
| PowerShell 7 on macOS | [CI workflow](https://github.com/AtlassianPS/AtlassianPS.Configuration/actions/workflows/ci.yml) |

## Acknowledgements

* Thanks to everyone ([Our Contributors](https://atlassianps.org/#people)) that helped with this module

## Useful links

* [Source Code]
Expand All @@ -88,7 +108,7 @@ Hopefully this is obvious, but:
[Latest Release]: https://github.com/AtlassianPS/AtlassianPS.Configuration/releases/latest
[Submit an Issue]: https://github.com/AtlassianPS/AtlassianPS.Configuration/issues/new
[MIT license]: https://github.com/AtlassianPS/AtlassianPS.Configuration/blob/master/LICENSE
[Contributing]: http://atlassianps.org/docs/Contributing
[Contributing]: https://atlassianps.org/docs/Contributing/

<!-- [//]: # (Sweet online markdown editor at http://dillinger.io) -->
<!-- [//]: # ("GitHub Flavored Markdown" https://help.github.com/articles/github-flavored-markdown/) -->
6 changes: 6 additions & 0 deletions docs/en-US/about_AtlassianPS.Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,12 @@ Find us on GitHub or Slack, and let us know what you think.

# SEE ALSO

[Commands index](/docs/AtlassianPS.Configuration/commands/)

[Classes index](/docs/AtlassianPS.Configuration/classes/)

[Enumerations index](/docs/AtlassianPS.Configuration/enumerations/)

[AtlassianPS org](https://atlassianps.org)

[AtlassianPS Slack team](https://atlassianps.org/slack)
Expand Down
11 changes: 11 additions & 0 deletions docs/en-US/classes/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: documentation
permalink: /docs/AtlassianPS.Configuration/classes/
hide: true
---
# AtlassianPS.Configuration classes

| Class | Documentation |
|---|---|
| `AtlassianPS.MessageStyle` | [AtlassianPS.MessageStyle](/docs/AtlassianPS.Configuration/classes/AtlassianPS.MessageStyle/) |
| `AtlassianPS.ServerData` | [AtlassianPS.ServerData](/docs/AtlassianPS.Configuration/classes/AtlassianPS.ServerData/) |
21 changes: 21 additions & 0 deletions docs/en-US/commands/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
layout: documentation
permalink: /docs/AtlassianPS.Configuration/commands/
hide: true
---
# AtlassianPS.Configuration commands

AtlassianPS.Configuration exports these commands with the `Atlassian` default command prefix.
The documentation pages use the source function names that back the exported commands.

| Exported command | Documentation |
|---|---|
| `Add-AtlassianServerConfiguration` | [Add-ServerConfiguration](/docs/AtlassianPS.Configuration/commands/Add-ServerConfiguration/) |
| `Get-AtlassianConfiguration` | [Get-Configuration](/docs/AtlassianPS.Configuration/commands/Get-Configuration/) |
| `Get-AtlassianServerConfiguration` | [Get-ServerConfiguration](/docs/AtlassianPS.Configuration/commands/Get-ServerConfiguration/) |
| `Remove-AtlassianConfiguration` | [Remove-Configuration](/docs/AtlassianPS.Configuration/commands/Remove-Configuration/) |
| `Remove-AtlassianServerConfiguration` | [Remove-ServerConfiguration](/docs/AtlassianPS.Configuration/commands/Remove-ServerConfiguration/) |
| `Set-AtlassianConfiguration` | [Set-Configuration](/docs/AtlassianPS.Configuration/commands/Set-Configuration/) |
| `Set-AtlassianServerConfiguration` | [Set-ServerConfiguration](/docs/AtlassianPS.Configuration/commands/Set-ServerConfiguration/) |

For module overview and setup, see [about_AtlassianPS.Configuration](/docs/AtlassianPS.Configuration/).
10 changes: 10 additions & 0 deletions docs/en-US/enumerations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
layout: documentation
permalink: /docs/AtlassianPS.Configuration/enumerations/
hide: true
---
# AtlassianPS.Configuration enumerations

| Enumeration | Documentation |
|---|---|
| `AtlassianPS.ServerType` | [AtlassianPS.ServerType](/docs/AtlassianPS.Configuration/enumerations/AtlassianPS.ServerType/) |
12 changes: 12 additions & 0 deletions docs/en-US/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: documentation
permalink: /docs/AtlassianPS.Configuration/about/
hide: true
---
# AtlassianPS.Configuration about topics

AtlassianPS.Configuration provides shared server configuration helpers used by AtlassianPS modules.

| Topic | Documentation |
|---|---|
| `about_AtlassianPS.Configuration` | [AtlassianPS.Configuration overview](/docs/AtlassianPS.Configuration/) |
Loading