Skip to content
Closed
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
2 changes: 2 additions & 0 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
- name: Documentation
path: docs
childs:
- name: Quick Start
path: docs/quick-start.html
- name: Contributing
path: docs/Contributing
listChilds: true
Expand Down
24 changes: 21 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,26 @@ hide: true
---
# Documentation

Here you will find an overview of the documentation section of this site.
Use these docs to install AtlassianPS modules, connect to Atlassian products, and find command reference material.

Please help us improve this page.
## Start here

Use the menu above to find what you are looking for.
- [Quick Start](quick-start.html): install a module, configure a server, and run your first command.
- [Modules](/module/): compare active and legacy AtlassianPS modules.
- [Contributing](Contributing/): report issues, improve docs, or submit code.
- [Gallery](Gallery/): browse community examples.

## Active modules

| Module | Status | Use it for | Documentation | Package |
| ------ | ------ | ---------- | ------------- | ------- |
{% assign activeModules = site.data.modules | where: "status", "active" %}
{% for module in activeModules %}| [{{ module.name }}]({{ module.path }}) | {{ module.status }} | {{ module.description }} | [Docs]({{ module.docs }}) | [Gallery]({{ module.gallery }}) |
{% endfor %}

## Common paths

- Automating Jira issues? Start with [JiraPS](JiraPS/) and the [JiraPS command reference](JiraPS/commands/).
- Automating Confluence? Start with [ConfluencePS](ConfluencePS/) and the [ConfluencePS command reference](ConfluencePS/commands/).
- Sharing server configuration across modules? Start with [AtlassianPS.Configuration](AtlassianPS.Configuration/).
- Working with Jira Agile resources? Start with [JiraAgilePS](JiraAgilePS/).
75 changes: 75 additions & 0 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
layout: documentation
title: Quick Start
---
# Quick Start

This page shows the shortest path from a fresh PowerShell session to a working AtlassianPS command.

## 1. Choose a module

Install the module that matches the product you want to automate.

```powershell
Install-Module JiraPS -Scope CurrentUser
Install-Module ConfluencePS -Scope CurrentUser
Install-Module JiraAgilePS -Scope CurrentUser
```

Use `AtlassianPS.Configuration` when you want shared server configuration across AtlassianPS modules.

```powershell
Install-Module AtlassianPS.Configuration -Scope CurrentUser
```

## 2. Import the module

```powershell
Import-Module JiraPS
```

Replace `JiraPS` with `ConfluencePS`, `JiraAgilePS`, or `AtlassianPS.Configuration` as needed.

## 3. Configure the server

For JiraPS, point the module at your Jira site.

```powershell
Set-JiraConfigServer -Server 'https://jira.example.com'
```

For other modules, see the module-specific docs linked below.

## 4. Authenticate

Start with an explicit credential while you are learning the module.

```powershell
$credential = Get-Credential
Get-JiraIssue -Issue 'PROJ-123' -Credential $credential
```

If you run many commands against the same server, review the module's session documentation.

## 5. Find commands

PowerShell can discover commands after importing a module.

```powershell
Get-Command -Module JiraPS
Get-Help Get-JiraIssue -Full
```

You can also browse the online command reference:

- [JiraPS commands](JiraPS/commands/)
- [ConfluencePS commands](ConfluencePS/commands/)
- [JiraAgilePS commands](JiraAgilePS/commands/)
- [AtlassianPS.Configuration commands](AtlassianPS.Configuration/commands/)

## Next steps

- Use [JiraPS](JiraPS/) for Jira issue, project, user, version, and workflow automation.
- Use [ConfluencePS](ConfluencePS/) for Confluence page and space automation.
- Use [JiraAgilePS](JiraAgilePS/) for Jira Agile boards, sprints, and related resources.
- Use [AtlassianPS.Configuration](AtlassianPS.Configuration/) to share Atlassian server configuration.