Skip to content

Commit c8d2b79

Browse files
authored
Merge pull request #60 from pipeops-dev/feature/docs-revamp
Update doc images to reflect new UI
2 parents 1294467 + cdb328c commit c8d2b79

40 files changed

+712
-364
lines changed

docs/Collaboration/teams.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,26 @@ Welcome to PipeOps Teams, a robust feature designed to help you efficiently mana
1212

1313
Begin by clicking on your profile in the navigation bar. This action will reveal a dropdown menu. From the dropdown, select "Teams," and you will be redirected to the Teams page, where all available teams can be accessed.
1414

15-
Below is an example of the Teams page in PipeOps:
15+
![Accessing Teams](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/access-teams.png)
1616

17-
![Teams View](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/39/access_teams_f126d3e595.png)
17+
Alternatively, click the ‘’New” button on the top right corner of your screen. Select “Team” from the dropdown menu.
1818

19-
## Viewing Team Members
19+
![Accessing Teams](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/create-team-nav.png)
2020

21-
To view the members of a team, simply click on the desired team. The image below provides a visual representation of the members of a specific team:
2221

23-
![Team Members View](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/39/view_team_6d8d5dc5bd.png)
22+
Below is an example of the Teams page in PipeOps:
23+
24+
![Teams Page Overview](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/teams-page.png)
25+
2426

2527
## Creating a New Team
2628

2729
Creating a new team is a straightforward process:
2830

29-
1. Click on the "+ New" button in the upper-right corner of the dashboard.
31+
1. On the **teams** page, click the "+ New team" button at the top-right of your screen. If you haven't created any teams yet, you'll also see a "+ create a new team" button at the center of the page.
32+
33+
![Create Team](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/create-team.png)
3034

31-
2. Select "Team" from the dropdown.
3235

3336
3. In the new page that appears, fill out the necessary information, including:
3437

@@ -44,17 +47,11 @@ Creating a new team is a straightforward process:
4447
4. Click "Create Team" to finalize the setup.
4548

4649

50+
![Create Team](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/create-team-overview-page.png)
4751

48-
Refer to the images below, which illustrate the step-by-step process of creating a new team:
49-
50-
![Create New Team 1](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/39/creating_team_e5af5b7751.png)
51-
52-
![Create New Team 2](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/39/team_cluster_7d4831ea3b.png)
53-
54-
![Create New Team 3](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/39/team_project_ac64eeed27.png)
5552

53+
**Note:** You can invite team members before you create a team. Navigate to the **Invite Team Member** section on the right side of the page to add collaborators. Alternatively, you can follow the instructions below to add team members.
5654

57-
Note: Team members can be invited after the team is created. Navigate to the **Invite Team Member** section on the right side of the page to add collaborators. Alternatively, you can follow the instructions below to add team members.
5855

5956

6057
## Adding Team Members
@@ -66,7 +63,16 @@ Adding a team member to a specific team is quick and easy:
6663

6764
Take a look at the image below, which displays the form for adding a new team member:
6865

69-
<!--![Add Team Member](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/39/add_team_member_150fa719f9.png)-->
66+
![Invite Member](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/teams-invite-member.png)
67+
68+
69+
70+
## Viewing Team Members
71+
72+
To view the members of a team, simply click on the desired team. The image below provides a visual representation of the members of a specific team:
73+
74+
![Team Members View](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/teams-view%20members.png)
75+
7076

7177

7278
## Team Audit Trail
@@ -79,6 +85,8 @@ The **Audit Trail** feature in PipeOps provides a detailed record of all actions
7985
2. Click on the specific team whose audit logs you wish to view.
8086
3. At the top of the page, select the Audit Trail tab.
8187

88+
![Team Audit](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/teams-audit.png)
89+
8290
### Audit Trail Features
8391

8492
The audit trail displays key details such as:

docs/Collaboration/workspaces.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ To view the list of available workspaces and switch between them, follow these s
1515
1. Click on the "Workspace" tab in the navbar.
1616
2. A dropdown menu will appear, displaying the list of workspaces available to you.
1717

18-
![Workspace Dropdown](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/40/workspace_7606f4a4a4.png)
18+
![Access Workspace](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/create-workspace-dropdown.png)
19+
1920

2021
The image above provides an example of the workspace dropdown, allowing you to choose from the available workspaces associated with your account.
2122

@@ -26,7 +27,9 @@ In addition to switching between existing workspaces, PipeOps also empowers you
2627
1. Click on the "Create New Workspace" button located in the workspace list dropdown.
2728
2. A form will be displayed, prompting you to provide the necessary information for the new workspace.
2829

29-
![Create New Workspace Form](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/40/create_workspace_1aa307b151.png)
30+
31+
![Create New Workspace](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/create-workspace-modal.png)
32+
3033

3134
The image above illustrates the form that will appear when creating a new workspace. Ensure to fill in the required details, such as a descriptive name for the workspace.
3235

docs/Integrations/aws-on-pipeops.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ sidebar_position: 1
44
title: Connect AWS to PipeOps
55
---
66

7-
87
# Connecting AWS Account to PipeOps
98

109
## Overview
@@ -17,25 +16,23 @@ To connect your AWS account to PipeOps, follow these steps:
1716

1817
1. On the left menu, click on the "Integrations" tab.
1918

20-
![PipeOps Cloud Integration Tab](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsCloudIntegrationTab.png)
19+
![Connect Cloud Provider](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/integrations-page.png)
2120

22-
2. Click on the AWS button among the list of cloud providers shown.
21+
2. Select AWS from the list of cloud providers shown and click the "Connect" button.
2322

24-
![PipeOps Cloud Providers List](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsConnectCloudProviderList.png)
23+
![Connect Cloud Provider](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/integrations-page.png)
2524

26-
3. On the "Connect AWS" screen, you can provide an optional name to identify your AWS account. The optional field is useful in scenarios when you want to connect more than one(1) AWS account on PipeOps.
25+
3. On the "Connect AWS" screen, you can provide an optional name to identify your AWS account. The optional field is useful in scenarios where you want to connect more than one(1) AWS account on PipeOps.
2726

28-
![PipeOps AWS Connection screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsAWSConnectionTab.png)
27+
![PipeOps AWS Connection screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-aws.png)
2928

3029
4. Fill in your AWS Account ID found at the top-right corner of your AWS account and an optional name.
3130

32-
![PipeOps AWS Connection screen filled](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsAWSConnectionFormFilled.png)
33-
3431
5. After filling out the form, click on the "Add" button. A spinner loads, enabling the "Authorize IAM" button.
3532

36-
6. Click on the "Authorize IAM" button. It should open a new tab to the right, opening a "Create Stacks" page on your AWS account which would need you to acknowledge "that AWS CloudFormation might create IAM resources with customised names" on the bottom of the page.
33+
6. Click on the "Authorize IAM" button. It should open a "Create Stacks" page in a new tab in your AWS account, which will prompt you to acknowledge "that AWS CloudFormation might create IAM resources with customised names" on the bottom of the page.
3734

38-
Then click on the "Create stack" button at the bottom right of the page.
35+
Click on the "Create stack" button at the bottom right of the page.
3936

4037
![PipeOps AWS Create Cloud Formation Stacks Page](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsAWSCreateStacksPage.png)
4138

@@ -45,7 +42,6 @@ Then click on the "Create stack" button at the bottom right of the page.
4542

4643
8. You can switch back to your PipeOps tab to the left and wait for a few seconds and your AWS account will automatically get connected.
4744

48-
![PipeOps AWS Create Cloud Formation Stack In Progess Page](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsAWSAccountConnected.png)
49-
50-
Now that you've connected your AWS account to PipeOps, you can create a server on your connected AWS account using this guide [here](/docs/servers/server-provisioning).
45+
![PipeOps AWS Create Cloud Formation Stack In Progess Page](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connected-aws.png)
5146

47+
Now that you've connected your AWS account to PipeOps, you can create a server on your connected AWS account using this [guide](/docs/servers/server-provisioning).

docs/Integrations/azure-on-pipeops.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,41 @@ title: Connect Azure to PipeOps
66

77
# Connecting Azure Account to PipeOps
88

9-
109
## Overview
1110

1211
This documentation will guide you through the process of connecting your Azure account to PipeOps. By following these steps, you’ll be able to create an Azure server on PipeOps and deploy projects on the server directly from your PipeOps dashboard.
1312

14-
1513
## Steps to follow
1614

1715
To connect your Azure account to PipeOps, follow these steps:
1816

19-
1. Ensure you have your Azure credentials. If not, you can follow this guide [here](/docs/how-to-guides/tutorials/generate-azure-credentials).
17+
1. Ensure you have your Azure credentials. If not, you can follow the guide [here](/docs/how-to-guides/tutorials/generate-azure-credentials).
2018

2119
2. On the left menu, click on the "Integrations" tab.
2220

23-
3. Select "Azure" from the list of cloud providers and click the "Proceed" button at the bottom right.
21+
![PipeOps Integration Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-azure.png)
22+
23+
3. Select "Azure" from the list of cloud providers and click the "Connect" button.
24+
25+
4. An instruction screen appears, outlining the steps required to create your Azure credentials.
26+
You can follow this guide [here](/docs/how-to-guides/tutorials/generate-azure-credentials) for a detailed walkthrough.
27+
28+
![Azure Instruction Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-azure-step-one.png)
29+
30+
5. On the "Enter Access Credentials" screen, you can provide an optional name to identify your Azure account. The optional field is useful in scenarios where you want to connect more than one Azure account on PipeOps.
2431

25-
4. On the "Enter Access Credentials" screen, you can provide an optional name to identify your Azure account. The optional field is useful in scenarios when you want to connect more than one Azure account on PipeOps.
32+
![Enter Azure Credentials](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-azure-step-two.png)
2633

27-
5. Fill in the required fields with your credentials:
34+
Fill in the required fields with your credentials:
2835

29-
- Resource Group Name
30-
- Tenant ID
31-
- Client ID
32-
- Client Secret
33-
- Subscription ID
36+
- Resource Group Name
37+
- Tenant ID
38+
- Client ID
39+
- Client Secret
40+
- Subscription ID
3441

3542
6. Click the submit button. If the credentials are correct, PipeOps will successfully integrate with Azure.
3643

44+
![Connected Azure Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connected-azure-screen.png)
3745

38-
Now that you've connected your Azure account to PipeOps, you can create a server on your connected Azure account using this guide [here](/docs/servers/server-provisioning).
46+
Now that you've connected your Azure account to PipeOps, you can create a server on your connected Azure account using this [guide](/docs/servers/server-provisioning).

docs/Integrations/do-on-pipeops.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,18 @@ To connect your Digital Ocean account to PipeOps, follow these steps:
1616

1717
1. In the PipeOps Dashboard, click on the "Integrations" tab from the left menu.
1818

19-
2. Select "Digital Ocean" from the list of cloud providers and click "Connect" to proceed.
19+
2. Select "Digital Ocean" from the list of cloud providers and click "Connect" to proceed.
20+
21+
![PipeOps Cloud Providers List](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-do-main-page.png)
2022

2123
3. On the **Authorize DigitalOcean** screen, click the "Authorize my Digital Ocean" button. This will open a new tab to the right.
2224

25+
![PipeOps Cloud Providers List](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-digital-ocean.png)
26+
2327
4. You will be redirected to DigitalOcean’s authorization page, as shown below. Click the "**Authorize Authorization**" button to grant PipeOps the necessary permissions.
2428

2529
5. After authorization, you will be redirected back to PipeOps. If successful, you'll see DigitalOcean listed as a connected provider.
2630

31+
![Connected Digital Ocean Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connected-do-screen.png)
2732

28-
Now that you've connected your Digital Ocean account to PipeOps, you can create a server on your connected account using this guide [here](/docs/servers/server-provisioning).
33+
Now that you've connected your Digital Ocean account to PipeOps, you can create a server on your connected account using this [guide](/docs/servers/server-provisioning).

docs/Integrations/gcp-on-pipeops.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,30 @@ title: Connect GCP to PipeOps
1010

1111
This documentation will guide you through the process of connecting your GCP account to PipeOps. By following these steps, you’ll be able to create a GCP server on PipeOps and deploy projects on the server directly from your PipeOps dashboard.
1212

13-
1413
## Steps to follow
1514

1615
To connect your GCP account to PipeOps, follow these steps:
1716

18-
1. Ensure you have downloaded your GCP JSON credentials. If not, you can follow this guide [here](/docs/how-to-guides/tutorials/generate-gcp-json-credentials).
17+
1. Ensure you have downloaded your GCP JSON credentials. If not, you can follow the guide [here](/docs/how-to-guides/tutorials/generate-gcp-json-credentials).
1918

2019
2. On the left menu, click on the "Integrations" tab.
2120

22-
![PipeOps Cloud Integration Tab](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsCloudIntegrationTab.png)
21+
![PipeOps Cloud Integration Tab](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-gcp.png)
22+
23+
3. Select "Google Cloud Platform" from the list of cloud providers shown and click the "Connect" button.
24+
2325

24-
3. Select "Google Cloud Platform" from the list of cloud providers shown and click the "Proceed" button at the bottom right.
26+
4. An instruction screen appears, outlining the steps required to generate your GCP credentials.
27+
You can follow this guide [here](/docs/how-to-guides/tutorials/generate-gcp-json-credentials) for a detailed walkthrough.
2528

26-
![PipeOps Cloud Providers List](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsConnectCloudProviderList.png)
29+
![GCP Instruction Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-gcp-step-one.png)
2730

2831

29-
4. On the "Upload Credentials JSON" screen, you can provide an optional name to identify your uploaded GCP JSON credentials. The optional field is useful in scenarios when you want to connect more than one(1) GCP account on PipeOps.
32+
5. On the "Upload Credentials JSON" screen, you can provide an optional name to identify your uploaded GCP JSON credentials. The optional field is useful in scenarios where you want to connect more than one GCP account on PipeOps.
3033

31-
![PipeOps GCP JSON Credentials Upload Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsGCPJSONCredentialsFilled.png)
34+
![PipeOps GCP JSON Credentials Upload Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-gcp-step-two.png)
3235

33-
5. Click on the submit button at the bottom right, and if the JSON credentials are valid, your GCP Account is successfully connected.
36+
6. Click on the submit button at the bottom right. If the JSON credentials are valid, your GCP account will be successfully connected.
3437

35-
![PipeOps GCP Connection screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsGCPCredentialsUploaded.png)
3638

37-
Now that you've connected your GCP account to PipeOps, you can create a server on your connected GCP account using this guide [here](/docs/servers/server-provisioning).
39+
Now that you've connected your GCP account to PipeOps, you can create a server on your connected GCP account using this [guide](/docs/servers/server-provisioning).

docs/Integrations/huawei-on-pipeops.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,27 @@ title: Connect Huawei to PipeOps
1010

1111
This documentation will guide you through the process of connecting your Huawei account to PipeOps. By following these steps, you’ll be able to create a Huawei server on PipeOps and deploy projects on the server directly from your PipeOps dashboard.
1212

13-
1413
## Steps to follow
1514

1615
To connect your Huawei account to PipeOps, follow these steps:
1716

18-
1. Ensure you have downloaded your Huawei credentials (a CSV file). If not, you can follow this guide [here](/docs/how-to-guides/tutorials/generate-huawei-credentials).
17+
1. Ensure you have downloaded your Huawei credentials (a CSV file). If not, you can follow the guide [here](/docs/how-to-guides/tutorials/generate-huawei-credentials).
1918

2019
2. On the left menu, click on the "Integrations" tab.
2120

22-
![PipeOps Cloud Integration Tab](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsCloudIntegrationTab.png)
23-
24-
3. Click on the Huawei button among the list of cloud providers shown and click the "Proceed" button at the bottom right of the page.
25-
26-
![PipeOps Cloud Providers List](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsConnectCloudProviderList.png)
21+
![PipeOps Cloud Integration Tab](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-huawei.png)
2722

28-
4. On the "Enter Access Credentials" screen, you can provide an optional name to identify your Huawei account. The optional field is useful in scenarios when you want to connect more than one(1) Huawei account on PipeOps. Then provide your "Access Key" and "Secret Key" from the CSV file you downloaded.
23+
3. Click on the Huawei button among the list of cloud providers shown and click the "Connect" button.
2924

25+
4. An instruction screen appears, outlining the steps required to generate your Huawei credentials.
26+
You can follow this guide [here](/docs/how-to-guides/tutorials/generate-huawei-credentials) for a detailed walkthrough.
3027

31-
![PipeOps Huawei Credentials Input Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/PipeOpsHuaweiCloudCredentialsForm.png)
28+
![Huwawei Instruction Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-huawei-step-one.png)
3229

33-
5. Click on the submit button at the bottom right and if the Huawei credentials are valid, then your Huawei Account is successfully connected.
30+
5. On the "Enter Access Credentials" screen, you can provide an optional name to identify your Huawei account. The optional field is useful in scenarios where you want to connect more than one Huawei account on PipeOps. Then provide your "Access Key" and "Secret Key" from the CSV file you downloaded.
3431

35-
![PipeOps Huawei Connection screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/HuaweiConnectionScreen.png)
32+
![PipeOps Huawei Credentials Input Screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/connect-huawei-step-two.png)
3633

37-
Now that you've connected your Huawei account to PipeOps, you can create a server on your connected Huawei account using this guide [here](/docs/servers/server-provisioning).
34+
6. Click on the submit button at the bottom right. If the Huawei credentials are valid, your Huawei account will be successfully connected.
3835

36+
Now that you've connected your Huawei account to PipeOps, you can create a server on your connected Huawei account using this [guide](/docs/servers/server-provisioning).

0 commit comments

Comments
 (0)