diff --git a/.gitmodules b/.gitmodules index 5a72c1b..e40fc39 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,24 +1,22 @@ -[submodule "modules/ConfluencePS"] - path = modules/ConfluencePS - url = https://github.com/AtlassianPS/ConfluencePS.git - branch = master -[submodule "modules/JiraPS"] - path = modules/JiraPS - url = https://github.com/AtlassianPS/JiraPS.git - branch = master -[submodule "modules/HipChatPS"] - path = modules/HipChatPS - url = https://github.com/AtlassianPS/HipChatPS.git - branch = master -[submodule "modules/BitbucketPS"] - path = modules/BitbucketPS - url = https://github.com/AtlassianPS/BitbucketPS.git - branch = master [submodule "modules/AtlassianPS"] path = modules/AtlassianPS url = https://github.com/AtlassianPS/AtlassianPS.git - branch = master [submodule "modules/AtlassianPS.Configuration"] path = modules/AtlassianPS.Configuration url = https://github.com/AtlassianPS/AtlassianPS.Configuration.git - branch = master +[submodule "modules/BitbucketPS"] + path = modules/BitbucketPS + url = https://github.com/AtlassianPS/BitbucketPS.git +[submodule "modules/ConfluencePS"] + path = modules/ConfluencePS + url = https://github.com/AtlassianPS/ConfluencePS.git +[submodule "modules/HipChatPS"] + path = modules/HipChatPS + url = https://github.com/AtlassianPS/HipChatPS.git +[submodule "modules/JiraAgilePS"] + path = modules/JiraAgilePS + url = https://github.com/AtlassianPS/JiraAgilePS.git +[submodule "modules/JiraPS"] + path = modules/JiraPS + url = https://github.com/AtlassianPS/JiraPS.git + diff --git a/_data/index/modules.yml b/_data/index/modules.yml index 44adbce..c7203ec 100644 --- a/_data/index/modules.yml +++ b/_data/index/modules.yml @@ -2,5 +2,6 @@ # - name: BitbucketPS - name: ConfluencePS # - name: HipChatPS +- name: JiraAgilePS - name: JiraPS - name: AtlassianPS.Configuration diff --git a/_data/index/people.yml b/_data/index/people.yml index 690603f..1c06941 100644 --- a/_data/index/people.yml +++ b/_data/index/people.yml @@ -34,6 +34,12 @@ short_desc: long_desc: +- name: Marc R Kellerman + role: Reviewer + gh_user: mkellerman + short_desc: + long_desc: + - name: Joel Bennett (@jaykul) role: Architecture consultant gh_user: jaykul diff --git a/_data/modules.yml b/_data/modules.yml index 021ad8d..81fe771 100644 --- a/_data/modules.yml +++ b/_data/modules.yml @@ -10,6 +10,10 @@ # description: ToDo # github: https://github.com/AtassianPS/HipChatPS # path: /module/HipChatPS +- name: JiraAgilePS + description: PowerShell module to interact with Jira's Agile plugin + github: https://github.com/AtassianPS/JiraAgilePS + path: /module/JiraAgilePS - name: JiraPS description: PowerShell module to interact with Atlassian JIRA github: https://github.com/AtassianPS/JiraPS diff --git a/_data/navigation.yml b/_data/navigation.yml index bd1d133..312dc83 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -9,6 +9,8 @@ path: module/ConfluencePS # - name: HipChatPS # path: module/HipChatPS + - name: JiraAgilePS + path: module/JiraAgilePS - name: JiraPS path: module/JiraPS - name: Documentation diff --git a/assets/img/404_backdrop.jpg b/assets/img/404_backdrop.jpg new file mode 100644 index 0000000..33f2f3a Binary files /dev/null and b/assets/img/404_backdrop.jpg differ diff --git a/assets/img/JiraAgilePS.png b/assets/img/JiraAgilePS.png new file mode 100644 index 0000000..ff51c7d Binary files /dev/null and b/assets/img/JiraAgilePS.png differ diff --git a/assets/img/create_github_codespace.png b/assets/img/create_github_codespace.png new file mode 100644 index 0000000..c051cc8 Binary files /dev/null and b/assets/img/create_github_codespace.png differ diff --git a/docs/Contributing/index.md b/docs/Contributing/index.md index ae6f955..442a354 100644 --- a/docs/Contributing/index.md +++ b/docs/Contributing/index.md @@ -7,16 +7,21 @@ layout: documentation This page describes: -* [Thank you!](#thank-you) - * [Report anything that is not working as expected](#report-anything-that-is-not-working-as-expected) - * [Question current methods and solutions](#question-current-methods-and-solutions) - * [Write documentation](#write-documentation) - * [Fix errors](#fix-errors) - * [Contribute code](#contribute-code) -* [How To Report An Issue](#how-to-report-an-issue) -* [How To Submit Code Changes](#how-to-submit-code-changes) -* [Our Guidelines](#our-guidelines) -* [Useful Material](#useful-material) +- [Contributing to AtlassianPS](#contributing-to-atlassianps) + - [Overview](#overview) + - [Thank you!](#thank-you) + - [Report anything that is not working as expected](#report-anything-that-is-not-working-as-expected) + - [Question current methods and solutions](#question-current-methods-and-solutions) + - [Write documentation](#write-documentation) + - [Fix errors](#fix-errors) + - [Contribute code](#contribute-code) + - [How To Report An Issue](#how-to-report-an-issue) + - [How To Submit Code Changes](#how-to-submit-code-changes) + - [Development Container](#development-container) + - [Working locally (in VS Code)](#working-locally-in-vs-code) + - [Using Github Codespace](#using-github-codespace) + - [Our Guidelines](#our-guidelines) + - [Useful Material](#useful-material) ## Thank you! @@ -75,15 +80,16 @@ GitHub makes this easy. Each of our projects has an _Issuetracker_ where you can report your findings. -|Project|Link|# of open issues| -|-------|----|----------------| -|**AtlassianPS**||[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS/issues)| -|**AtlassianPS.Configuration**||[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.Configuration.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS.Configuration/issues)| -|**AtlassianPS.github.io**||[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.github.io.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS.github.io/issues)| -|**BitbucketPS**||[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/BitbucketPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/BitbucketPS/issues)| -|**ConfluencePS**||[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/ConfluencePS.svg?maxAge=2592000)](https://github.com/AtlassianPS/ConfluencePS/issues)| -|**HipchatPS**||[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/HipchatPSPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/HipchatPS/issues)| -|**JiraPS**||[![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/JiraPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/JiraPS/issues)| +| Project | Link | # of open issues | +| ----------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| **AtlassianPS** | | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS/issues) | +| **AtlassianPS.Configuration** | | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.Configuration.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS.Configuration/issues) | +| **AtlassianPS.github.io** | | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/AtlassianPS.github.io.svg?maxAge=2592000)](https://github.com/AtlassianPS/AtlassianPS.github.io/issues) | +| **BitbucketPS** | | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/BitbucketPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/BitbucketPS/issues) | +| **ConfluencePS** | | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/ConfluencePS.svg?maxAge=2592000)](https://github.com/AtlassianPS/ConfluencePS/issues) | +| **HipchatPS** | | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/HipchatPSPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/HipchatPS/issues) | +| **JiraAgilePS** | | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/JiraAgilePS.svg?maxAge=2592000)](https://github.com/AtlassianPS/JiraAgilePS/issues) | +| **JiraPS** | | [![Open Issues](https://img.shields.io/github/issues-raw/AtlassianPS/JiraPS.svg?maxAge=2592000)](https://github.com/AtlassianPS/JiraPS/issues) | New issues are created using a template which includes pre-defined text for reporting coding exceptions. If your issue is not related to a coding error (e.g. you are suggesting a new feature), please modify the content to suit your needs. @@ -112,6 +118,44 @@ It will be reviewed and, when approved, merged. There is a bit more to take into account when submitting code to the projects. You can read all about it here: **[Submitting A PR]**. +### Development Container + +Our repository includes a ["Dev Container"](https://containers.dev/) / GitHub Codespaces development container. + +> **What are Development Containers?** +> A development container (or dev container for short) allows you to use +> a container as a full-featured development environment. +> It can be used to run an application, to separate tools, libraries, +> or runtimes needed for working with a codebase, +> and to aid in continuous integration and testing. + +You can use the devcontainer to spin up a fine tuned development environment with +everything you need for working on AtlassianPS projects. + +You can use the devcontainer in your favorite edit or github codespace. + +#### Working locally (in VS Code) + +You can use the bellow links to get started. +The links will trigger VS Code to automatically install the Dev Containers extension if needed, +clone the source code into a container volume, and spin up a dev container for use. + +- [AtlassianPS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/atlassianps) +- [AtlassianPS.Configuration](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/atlassianps.configuration) +- [AtlassianPS.github.io](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/atlassianps.github.io) +- [BitbucketPS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/bitbucketps) +- [ConfluencePS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/confluenceps) +- [JiraAgilePS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/jiraagileps) +- [JiraPS](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/atlassianps/jiraps) + +#### Using Github Codespace + +Github allows you to spin up a virtual editor ("VS Code in your browser"). +You can create your own codespace by navigating to +or by using the "Code" button in the repository itself, as shown bellow. + +![Create Codespace In Repository](../../assets/img/create_github_codespace.png) + ## Our Guidelines We strive for making the process of contributing as easy as possible. @@ -121,8 +165,8 @@ When contributing to the code, please follow [Our Guidelines](our-guidelines.htm ## Useful Material -* GitHub's guide on [Contributing to Open Source](https://guides.github.com/activities/contributing-to-open-source/#pull-request) -* [GitHub Flow Guide](https://guides.github.com/introduction/flow/): step-by-step instructions of GitHub flow. +- GitHub's guide on [Contributing to Open Source](https://guides.github.com/activities/contributing-to-open-source/#pull-request) +- [GitHub Flow Guide](https://guides.github.com/introduction/flow/): step-by-step instructions of GitHub flow. [AtlassianPS.Slack]: https://atlassianps.org/slack/ diff --git a/docs/Contributing/our-guidelines.md b/docs/Contributing/our-guidelines.md index f378658..5e37151 100644 --- a/docs/Contributing/our-guidelines.md +++ b/docs/Contributing/our-guidelines.md @@ -7,18 +7,20 @@ layout: documentation This page describes: -* [Code Formatting and Conventions](#code-formatting-and-conventions) - * [Formatting](#formatting) - * [Templates](#templates) - * [Variable Naming](#variable-naming) - * [Function Naming](#function-naming) - * [Splatting](#splatting) - * [Aliases](#aliases) - * [In-code Documentation](#in-code-documentation) -* [Code Separation and File Naming](#code-separation-and-file-naming) -* [Strive for 100% Code Coverage by Tests](#strive-for-100-code-coverage-by-tests) -* [Changes To the Build System](#changes-to-the-build-system) -* [Submitting Pull Requests](#submitting-pull-requests) +- [Our Guidelines](#our-guidelines) + - [Overview](#overview) + - [Code Formatting and Conventions](#code-formatting-and-conventions) + - [Formatting](#formatting) + - [Templates](#templates) + - [Variable Naming](#variable-naming) + - [Function Naming](#function-naming) + - [Splatting](#splatting) + - [Aliases](#aliases) + - [In-code Documentation](#in-code-documentation) + - [Code Separation and File Naming](#code-separation-and-file-naming) + - [Strive for 100% Code Coverage by Tests](#strive-for-100-code-coverage-by-tests) + - [Document as You Go](#document-as-you-go) + - [Changes To the Build System](#changes-to-the-build-system) ## Code Formatting and Conventions @@ -54,7 +56,8 @@ function Get-GlobalVariable { ``` Additional Information: -* [More about special case styles](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles) + +- [More about special case styles](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles) ### Function Naming @@ -104,10 +107,10 @@ If you feel you need to comment the code, you likely need to refactor it. ## Code Separation and File Naming -* all functions (public and private), classes, and enums should be defined in separate files and organized according to their category. -* do not define more than one function, class, or enum per file. -* do not create nested functions (use separate private functions instead). -* the filename should match the function or enum name. +- all functions (public and private), classes, and enums should be defined in separate files and organized according to their category. +- do not define more than one function, class, or enum per file. +- do not create nested functions (use separate private functions instead). +- the filename should match the function or enum name. ## Strive for 100% Code Coverage by Tests diff --git a/docs/Contributing/submitting-a-pr.md b/docs/Contributing/submitting-a-pr.md index 705830f..ce981df 100644 --- a/docs/Contributing/submitting-a-pr.md +++ b/docs/Contributing/submitting-a-pr.md @@ -7,70 +7,73 @@ layout: documentation This page describes: -* [TL;DR](#tldr) -* [The Basics](#the-setup) - * [New to Git(Hub)?](#new-to-github) - * [Tooling](#tooling) -* [Getting Started](#getting-started) - * [Find Something To Contribute To](#find-something-to-contribute-to) - * [Forking And Branching](#forking-and-branching) -* [Making Changes](#making-changes) - * [Getting Work Done](#getting-work-done) - * [Documenting Your Work](#documenting-your-work) - * [Making Sure All Is Working](#making-sure-all-is-working) -* [Sending Your Changes](#sending-your-changes) - * [Send A Pull Request](#send-a-pull-request) - * [What Happens Next?](#what-happens-next) +- [Submitting A Pull Request](#submitting-a-pull-request) + - [Overview](#overview) + - [TL;DR](#tldr) + - [The Setup](#the-setup) + - [New to Git(Hub)?](#new-to-github) + - [Tooling](#tooling) + - [Getting Started](#getting-started) + - [Find Something To Contribute To](#find-something-to-contribute-to) + - [Forking And Branching](#forking-and-branching) + - [Making Changes](#making-changes) + - [Getting Work Done](#getting-work-done) + - [Documenting Your Work](#documenting-your-work) + - [Making Sure All Is Working](#making-sure-all-is-working) + - [Sending Your Changes](#sending-your-changes) + - [Send A Pull Request](#send-a-pull-request) + - [What Happens Next?](#what-happens-next) ## TL;DR Here is a list for project specific instructions. These are more technical - pretty much what would have to be executed in the console. -|Project|Instructions| -|-------|------------| -|**AtlassianPS**|| -|**AtlassianPS.Configuration**|| -|**AtlassianPS.github.io**|| -|**BitbucketPS**|| -|**ConfluencePS**|| -|**HipchatPS**|| -|**JiraPS**|| +| Project | Instructions | +| ----------------------------- | -------------------------------------------------------------------------------------- | +| **AtlassianPS** | | +| **AtlassianPS.Configuration** | | +| **AtlassianPS.github.io** | | +| **BitbucketPS** | | +| **ConfluencePS** | | +| **HipchatPS** | | +| **JiraAgilePS** | | +| **JiraPS** | | ## The Setup ### New to Git(Hub)? -* Make sure you have a [GitHub account](https://github.com/signup/free). -* Learning Git: - * GitHub Help: [Good Resources for Learning Git and GitHub][good-git-resources]. - * [Git Basics](https://github.com/PowerShell/PowerShell/blob/master/docs/git/basics.md): install and getting started. +- Make sure you have a [GitHub account](https://github.com/signup/free). +- Learning Git: + - GitHub Help: [Good Resources for Learning Git and GitHub][good-git-resources]. + - [Git Basics](https://github.com/PowerShell/PowerShell/blob/master/docs/git/basics.md): install and getting started. ### Tooling To make changes to the code or documentation and send it as a Pull Request, only one tool is required: -* **[Git]** +- **[Git]** _There are many different ways to install Git._ _Please google how to install it on your OS._ -* **PowerShell** +- **PowerShell** _Any version works._ _If you are using version 3 or 4, the `PowerShellGet` module must be installed._ -* **[InvokeBuild]** +- **[InvokeBuild]** _Additional required modules are installed when `Invoke-Build` is called._ There are more tools that are not _required_, but will make life much easier. Such as: -|Tool|Description| -|----|-----------| -|[Graphic Interfaces for Git](https://git-scm.com/downloads/guis)|_Git can get messy. A nice UI can be helpful. This page contains some for you to use._| -|[Visual Studio Code]|_This is the editor of choice for working with Powershell. The project contains settings to make life easier._| -|[PowerShell Extension for VSCode]|_This extension provides rich PowerShell language support for Visual Studio Code. Now you can write and debug PowerShell scripts using the excellent IDE-like interface that Visual Studio Code provides._| -|[Plaster Module]|_Plaster is a template-based file and project generator written in PowerShell._| -|[Pester Module]|_Build Automation in PowerShell. Will be installed as a dependency with `Invoke-Build`._| -|[PlatyPS]|_Write PowerShell External Help in Markdown._| +| Tool | Description | +| ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Graphic Interfaces for Git](https://git-scm.com/downloads/guis) | _Git can get messy. A nice UI can be helpful. This page contains some for you to use._ | +| [Visual Studio Code] | _This is the editor of choice for working with Powershell. The project contains settings to make life easier._ | +| [PowerShell Extension for VSCode] | _This extension provides rich PowerShell language support for Visual Studio Code. Now you can write and debug PowerShell scripts using the excellent IDE-like interface that Visual Studio Code provides._ | +| [Plaster Module] | _Plaster is a template-based file and project generator written in PowerShell._ | +| [Pester Module] | _Build Automation in PowerShell. Will be installed as a dependency with `Invoke-Build`._ | +| [PlatyPS] | _Write PowerShell External Help in Markdown._ | ## Getting Started @@ -87,24 +90,27 @@ into their own user account, where they can make private changes to their fork. Once you have your own version of the project, you should: -* Clone your version of the project to your computer +- Clone your version of the project to your computer _Here is how: [Cloning a Repository](https://help.github.com/articles/cloning-a-repository/)._ -```powershell -git clone https://github.com//.git -``` -* Create a new branch for your changes + +** ```powershell + git clone https://github.com//.git + ```** + +- Create a new branch for your changes _You should make the changes in a branch for tracking them._ _You should also create your own branch out of `develop`._ _You can read more here: [Git Flow Guide](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)._ -```powershell -cd -git checkout develop -git checkout -b -``` + + ```powershell + cd + git checkout develop + git checkout -b + ``` Additional references: -* GitHub's guide on [forking](https://guides.github.com/activities/forking/) +- GitHub's guide on [forking](https://guides.github.com/activities/forking/) ## Making Changes @@ -117,6 +123,7 @@ However, there are some [Guidelines](our-guidelines.html) which should be follow The checklist when creating the Pull Request will look something like this: > **Types of changes:** +> > - [ ] Bug fix (non-breaking change which fixes an issue) > - [ ] New feature (non-breaking change which adds functionality) > - [ ] Breaking change (fix or feature that would cause existing functionality to change) @@ -140,8 +147,8 @@ It is also expected that the tests that describe the functionality are either up Additional material: -* [How to write a function](writing-functions.html) -* [How to write good tests](writing-tests.html) +- [How to write a function](writing-functions.html) +- [How to write good tests](writing-tests.html) ### Making Sure All Is Working @@ -167,10 +174,10 @@ To help them, the GitHub repositories will use [CI](https://en.wikipedia.org/wik Every Pull Request must be approved after review and the reviewer(s) might: -* have some constructive feedback for your code and suggest optimizations (eg: adding `Write-Verbose` messages) -* request you to make specific changes before approving it (eg: adding tests) -* request changes to the documentation (eg: add a new _example_ to the function) -* push some changes to your code (eg: harmonize some code) +- have some constructive feedback for your code and suggest optimizations (eg: adding `Write-Verbose` messages) +- request you to make specific changes before approving it (eg: adding tests) +- request changes to the documentation (eg: add a new _example_ to the function) +- push some changes to your code (eg: harmonize some code) _By default, github grants "write" permissions to the reviewers to your fork._ _You can disable this, if you wish._ diff --git a/index.md b/index.md index bbf2a7e..d7defc8 100644 --- a/index.md +++ b/index.md @@ -1,6 +1,6 @@ --- layout: landingpage -title: index +title: AtlassianPS permalink: / sitemap: priority: 1.0