Skip to content

Commit e6140a1

Browse files
authored
docs: new UI updates (integration + application) (#374)
- Add Integrations page - Updates to Application page (remove version list, add in-place filter controls, tabbed compatability tiles)
1 parent 6cd698e commit e6140a1

21 files changed

+172
-47
lines changed

website/docs/docs/ui-old/dashboard.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
title: Dashboard
33
---
4+
:::warning
5+
The Legacy UI will be shut down on Friday, June 27th.
6+
:::
47

58
## Dashboard layout
69

website/docs/docs/user-interface/application.md

Lines changed: 57 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,60 +2,89 @@
22
title: Application
33
---
44

5-
Applications (or "Pacticipants") are at the center of the PactFlow experience. From this page, you can:
5+
## Application
66

7-
1. See all versions of your application.
8-
2. Discover all integrated applications and their contracts.
9-
3. See the health of the application at a glance.
10-
4. Check if your application is deployable.
11-
5. Configure your application settings.
7+
Applications—also called **Pacticipants**—are central to the PactFlow experience.
128

13-
### Version Details
9+
From this page, you can:
1410

15-
In the left-hand panel, you can see all versions of the currently selected application. Select a version to view its details.
11+
1. View all versions of your application.
12+
2. Discover all integrated applications and their contracts.
13+
3. See the application's overall health.
14+
4. Check if the application is deployable.
15+
5. Configure application settings.
1616

17-
![Application Page](/ui/clarity/application.png)
17+
### Application Versions
18+
19+
The **Application Versions** tab shows the latest version of the selected application, based on the designated main branch. Recent versions appear in adjacent tabs.
20+
21+
- Click a tab to view details for that version.
22+
- To view older versions, select **View All**.
23+
- To filter by branch or tag, click the corresponding label and update the filter. You can only filter by one at a time.
24+
25+
Your filter preferences are preserved when you return to this page.
26+
27+
Accessing this page updates the **Recent** list under **Applications** in the navigation panel.
28+
29+
![Application – Version Page](/ui/clarity/application-version.png)
1830

1931
### Compatibility
2032

21-
This tab displays each of the integrated applications as tiles, showing a summary of the verification status for each. Each tile has a historical bar chart showing the compatibility of previous versions. Hover over the bar chart to see details, or click to pin them.
33+
The **Compatibility** tab shows integrated applications as tiles, each summarizing verification status.
34+
35+
- Each tile includes tabs for previous verification results, ordered left to right with the most recent result first.
36+
- Integrated applications may act as either a **consumer** or a **provider**.
37+
38+
To update the data:
2239

23-
Select a branch in each tile to see versions related to that branch, or use the toggle at the top to quickly change all tiles to the latest updated or main branch.
40+
- Filter by **branch**, **tag**, or **environment** (only one at a time).
41+
- Select a branch within a tile to filter its versions.
42+
- Use the **toggle** at the top to apply the latest updated or main branch across all tiles.
2443

25-
Click "View contract" to see a contract for a specific version.
44+
Click:
2645

27-
![Application Page](/ui/clarity/application-compatibility-tile.png)
46+
- **View contract** to see contract details for a specific version.
47+
- **Triggered Webhooks** to view webhook events related to the integration.
48+
49+
![Application – Compatibility Tab](/ui/clarity/application-version-compatibility.png)
2850

2951
### Can I Deploy
3052

31-
This tab shows the current deployability to a given environment (see the [`can-i-deploy`](https://docs.pact.io/pact_broker/can_i_deploy) documentation for more information). You must select a team from the drop-down menu to fetch environments related to the selected team before the results can be displayed.
53+
The **Can I Deploy** tab shows the current deployability status for the application in a selected environment.
3254

33-
![Can I Deploy](/ui/clarity/application-cid.png)
55+
- Select a **team** from the drop-down to load the associated environments.
56+
- View the results to determine whether deployment is possible.
57+
58+
For details, see the [`can-i-deploy`](https://docs.pact.io/pact_broker/can_i_deploy) documentation.
3459

35-
Click on the link in the row to navigate to the specific verification result for a given entry.
60+
Click a link in the table to navigate to the corresponding verification result.
61+
62+
![Can I Deploy](/ui/clarity/application-cid.png)
3663

3764
### Network
3865

39-
This tab shows all applications directly integrated with the currently selected application. Click on a node to navigate to the collaborating application.
66+
The **Network** tab displays all applications directly integrated with the current application.
67+
68+
- Click a node to navigate to the collaborating application.
4069

41-
![Network Graph](/ui/clarity/application-network.png)
70+
![Application – Network Tab](/ui/clarity/application-network.png)
4271

43-
### Settings
72+
## Settings
4473

45-
#### General
74+
### General
4675

47-
This tab allows you to see and modify the display name of the application.
76+
Update the **display name** of the application in the **General** tab.
4877

49-
![Settings - General](/ui/clarity/application-settings.png)
78+
![Application – General Settings Page](/ui/clarity/application-settings-general.png)
5079

51-
#### Version Control
80+
### Version Control
5281

53-
This tab allows you to specify the main branch and repository URL (e.g., a GitHub URL) for the application.
82+
Specify the **main branch** and **repository URL** (for example, a GitHub URL) in the **Version Control** tab.
5483

55-
![Settings - Version Control](/ui/clarity/application-version-control.png)
84+
![Application – Version Control Settings Page](/ui/clarity/application-settings-version.png)
5685

57-
#### Badge
86+
### Badge
5887

59-
This tab allows you to generate `can-i-deploy` build badges for the current application.
88+
Generate `can-i-deploy` build badges in the **Badge** tab.
6089

61-
![Settings - Badge](/ui/clarity/application-badge.png)
90+
![Application – Badge Settings Page](/ui/clarity/application-settings-badges.png)

website/docs/docs/user-interface/dashboard.md

Lines changed: 78 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,101 @@
22
title: Dashboard
33
---
44

5-
This screen provides a quick way to discover and access your applications.
5+
This screen helps you quickly find and access your applications.
66

7-
![Dashboard](/ui/clarity/dashboard.png)
7+
![Dashboard – All Applications Tab](/ui/clarity/dashboard-all-applications.png)
88

9-
## Favourites / Quick Access
9+
## Applications
1010

11-
The top panel shows a subset of applications in a condensed view for quick access.
11+
### My Favourites
1212

13-
- Select "My Favourites" from the drop-down to see your saved applications.
14-
- Favourite an application by clicking the star icon in the list of applications below.
15-
- Remove an application from your favourites by clicking the cross icon.
13+
The **My Favourites** tab shows a condensed view of your saved applications for quick access.
1614

17-
![Favourites](/ui/clarity/dashboard-favourites.png)
15+
- Select **My Favourites** from the drop-down to view your saved applications.
16+
- Click the **star icon** next to an application to add it to your favourites.
17+
- Click the **cross icon** to remove an application from your favourites.
1818

19-
Select a team from the drop-down to see all applications in that team.
19+
You can favourite up to 20 applications.
2020

21-
## All Applications
21+
![Dashboard – Favourites Tab](/ui/clarity/dashboard-favourites.png)
2222

23-
The bottom panel shows all applications in the account. Use the search box to filter applications by their name or display name. If you have many applications, pagination controls will appear to aid navigation.
23+
### Applications by Team
2424

25-
![Search](/ui/clarity/dashboard-search.png)
25+
The **Applications by Team** tab displays all applications by team.
2626

27-
## Navigation
27+
- Select a team from the drop-down to view its applications.
28+
- You’ll see all teams listed if you have permission to view them.
2829

29-
#### Feedback / Switch UI
30+
Each application tile shows the **mergeability status** of the _main_ branch.
3031

31-
The feedback button allows you to switch back to the old UI or provide feedback on the new UI.
32+
This tab displays up to 20 applications.
3233

33-
#### Settings
34+
![Dashboard – Team Applications Tab](/ui/clarity/dashboard-team-applications.png)
35+
36+
### All Applications
37+
38+
The **All Applications** panel shows all applications in your organization.
39+
40+
- Use the **search box** to filter by name or display name.
41+
- If you have many applications, **pagination controls** will appear to help you navigate.
42+
43+
![Dashboard – All Applications Tab](/ui/clarity/dashboard-all-applications.png)
44+
45+
## Integrations
46+
47+
### Integrations Dashboard
3448

35-
The settings (cog) button takes you to all the setting screens, where you can set up [API tokens](#settings-api-tokens), [webhooks](#settings-webhooks), [users](#settings-users), and more.
49+
The **Integrations** page lists all integrations for your organization. An integration is a pair of a consumer and provider that share a pact.
50+
51+
- Use the **search box** to filter by name or display name.
52+
- If you have many integrations, **pagination controls** will appear.
53+
- Click an integration to go to its [integration page](/docs/user-interface/integration).
54+
55+
Each tile shows the compatibility status for the _latest_ version of the contract.
56+
57+
![Integrations Page](/ui/clarity/integrations.png)
58+
59+
## Navigation
60+
61+
### Top Navigation
62+
63+
#### Feedback / Switch UI
64+
65+
Click **Feedback** to switch to the old UI or submit feedback on the new UI.
3666

3767
#### Help
3868

39-
The help link directs you to our documentation.
69+
Click **Help** to open the documentation.
4070

4171
#### Profile
4272

43-
The profile link shows the currently logged-in user, the current version of PactFlow, and a link to log out.
73+
The **Profile** link shows:
74+
75+
- The currently logged-in user.
76+
- The current PactFlow version.
77+
- A link to log out.
78+
79+
### Side Navigation
80+
81+
#### Applications
82+
83+
Quickly access your most frequent or recently used applications. Navigate to the application dashboard.
84+
85+
![Navigation – Applications](/ui/clarity/navigation-applications.png)
86+
87+
#### Integrations
88+
89+
Quickly access your most frequent or recently used integrations. Navigate to the integration dashboard.
90+
91+
![Navigation – Integrations](/ui/clarity/navigation-integrations.png)
92+
93+
#### Settings
94+
95+
Click the **Settings (cog)** icon to access all configuration screens, including:
96+
97+
- [API tokens](#settings-api-tokens)
98+
- [Webhooks](#settings-webhooks)
99+
- [Users](#settings-users)
100+
- And more
101+
102+
![Navigation – Left](/ui/clarity/navigation-left.png)
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Integration
3+
---
4+
5+
This page provides compatibility details for a specific integration.
6+
7+
### Matrix
8+
9+
The **Matrix** is a table that shows the verification status for each combination of consumer and provider versions in the selected integration.
10+
11+
Use the Matrix to:
12+
13+
- Quickly check compatibility between applications.
14+
- Narrow down the data using filters.
15+
16+
You can filter **consumer versions** and **provider versions** by selecting:
17+
18+
- Links in the table.
19+
- Filters in the table headers, including version, branch, environment, or tag.
20+
21+
> **Note:** You can filter each participant independently, but only by one facet at a time.
22+
23+
:::tip
24+
The **Environment** filter appears only if you have *read* or *manage* permissions for environments.
25+
:::
26+
27+
Click **View contract** in any row to open the corresponding contract.
28+
29+
![Integration – Matrix Page](/ui/clarity/integrations-matrix.png)
30+
31+
### Webhooks
32+
33+
The **Webhooks** section lists all triggered webhooks for the integration, along with their associated logs.

website/sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ module.exports = {
1212
'docs/user-interface/migration/new',
1313
'docs/user-interface/dashboard',
1414
'docs/user-interface/application',
15+
'docs/user-interface/integration',
1516
'docs/user-interface/contract',
1617
'docs/user-interface/bi-directional',
1718
{
921 KB
Loading
-54.7 KB
Loading
813 KB
Loading
913 KB
Loading
928 KB
Loading

0 commit comments

Comments
 (0)