Skip to content

Commit

Permalink
Add images for prdeploy portal
Browse files Browse the repository at this point in the history
  • Loading branch information
greggbjensen committed Aug 26, 2024
1 parent 9a51d8a commit 840d69f
Show file tree
Hide file tree
Showing 14 changed files with 90 additions and 2 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 12 additions & 1 deletion docs/deployment-queues.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
The **prdeploy** app keeps on pull request per environment, to minimize the changes needed to test and keep deployments running quickly. Because there can be multiple engineers working from the same repository and set of services, if an envirionment is in use, a pull request will be added to the queue and then deployed automatically when the environment is free.

## Queue status comment

If a queue is in use, your deployment will be placed in line and automatically deployed when the environment is free.

![Deployment queue comment](./assets/images/screenshots/deployment-queues.png)
{: style="margin: 50px 0 0 0;"}
{: style="margin: 50px 0 0 0;"}

## Queue management

You can use the **prdeploy** portal to reorder queue for priority, as well as add and remove pull requests.

![prdeploy queues](./assets/images/screenshots/prdeploy-portal-queues.png)
{: style="margin: 30px 0 20px 0;"}
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ The **prdeploy** application supplies the following features:

2. [prdeploy portal](prdeploy-portal.md) dashboard to overview releases and deployment queues and act on them.

![prdeploy deployments](./assets/images/screenshots/prdeploy-portal.png)
{: style="margin: 30px 0 60px 0; box-shadow: rgba(0, 0, 0, 0.2) 0px 3px 3px -2px, rgba(0, 0, 0, 0.14) 0px 3px 4px 0px, rgba(0, 0, 0, 0.12) 0px 1px 8px 0px;"}


3. [Slack notifications](slack-notifications.md) for posting events to keep your process moving.

Expand Down
76 changes: 75 additions & 1 deletion docs/prdeploy-portal.md
Original file line number Diff line number Diff line change
@@ -1 +1,75 @@
The **prdeploy** has a portal that uses your GitHub Login to be able to see all your environments and their pull requests, as well as manage the queues of waiting pull requests. You can also execute all of the [comment commands](comment-commands.md) though an easy to use interface.
The **prdeploy** has a portal that uses your GitHub Login to be able to see all your environments and their pull requests, as well as manage the queues of waiting pull requests. You can also execute all of the [comment commands](comment-commands.md) though an easy to use interface.

![prdeploy deployments](./assets/images/screenshots/prdeploy-portal.png)
{: style="margin: 30px 0 60px 0; box-shadow: rgba(0, 0, 0, 0.2) 0px 3px 3px -2px, rgba(0, 0, 0, 0.14) 0px 3px 4px 0px, rgba(0, 0, 0, 0.12) 0px 1px 8px 0px;"}

## Run comment commands

From the **Deployments** grid, you can click the actions to run comment commands directly.

![prdeploy actions](./assets/images/screenshots/prdeploy-portal-actions.png)
{: style="margin: 30px 0 20px 0;"}

## Manage environment queue

From the **Queues** list, you can reorder, add to, and delete from the current queue to optimize your use of the environment.

![prdeploy queues](./assets/images/screenshots/prdeploy-portal-queues.png)
{: style="margin: 30px 0 20px 0;"}

## Compare environments

The **Environments** page allows you compare versions of services accross environments.

![prdeploy environment compare](./assets/images/screenshots/prdeploy-portal-environments.png)
{: style="margin: 30px 0 60px 0; box-shadow: rgba(0, 0, 0, 0.2) 0px 3px 3px -2px, rgba(0, 0, 0, 0.14) 0px 3px 4px 0px, rgba(0, 0, 0, 0.12) 0px 1px 8px 0px;"}

## Manage repositories

With the **Repositories** page, you can configure new or remove existing repositories to use **prdeploy** with.

![prdeploy repositories](./assets/images/screenshots/prdeploy-portal-repositories.png)
{: style="margin: 30px 0 60px 0; box-shadow: rgba(0, 0, 0, 0.2) 0px 3px 3px -2px, rgba(0, 0, 0, 0.14) 0px 3px 4px 0px, rgba(0, 0, 0, 0.12) 0px 1px 8px 0px;"}

## Configure settings

In the **Settings** page, your **Environments**, **[JIRA](jira-links.md)**, and **[Slack](slack-notifications.md)** integrations can be managed. You can also adjust your **Deployment** settings. Settings can be set at the **Organization** level for all repositories, then overriden for individual **Repositories** as needed.

![prdeploy settings](./assets/images/screenshots/prdeploy-portal-settings.png)
{: style="margin: 30px 0 60px 0; box-shadow: rgba(0, 0, 0, 0.2) 0px 3px 3px -2px, rgba(0, 0, 0, 0.14) 0px 3px 4px 0px, rgba(0, 0, 0, 0.12) 0px 1px 8px 0px;"}

### Environments

Configure all of your available environments, if they should always be up to date, and if there is a gate to approve them.

![prdeploy settings Environments](./assets/images/screenshots/prdeploy-portal-settings-environments.png)
{: style="margin: 30px 0 60px 0;"}

### Services

Setting up your services allows you to add specific ones to your pull request with the comment `/add my-service` when it is not detected to include automatically.

![prdeploy settings Services](./assets/images/screenshots/prdeploy-portal-settings-services.png)
{: style="margin: 30px 0 60px 0;"}

### Slack

In the **Slack** section you can specify your settings for posting deploy and release notifications. You can also alias email addresses to the correct Slack email if they are incorrect.

![prdeploy settings Slack](./assets/images/screenshots/prdeploy-portal-settings-slack.png)
{: style="margin: 30px 0 60px 0;"}

### JIRA

Configuring **JIRA** allows **prdeploy** to be able to automatically link issues to your pull request.

![prdeploy settings JIRA](./assets/images/screenshots/prdeploy-portal-settings-jira.png)
{: style="margin: 30px 0 60px 0;"}

### Deployment

With the **Deployment** section you can adjust your default and release environment, as well as the colors to post in comments for status. It is also important to set your **prdeploy portal URL** so the comment badges can link to the portal.

![prdeploy settings Deployment](./assets/images/screenshots/prdeploy-portal-settings-deployment.png)
{: style="margin: 30px 0 60px 0;"}

0 comments on commit 840d69f

Please sign in to comment.