Skip to content

Commit 47c9ecf

Browse files
committed
Refine documentation for mapping Git users to Port accounts by improving clarity and structure. Updated bullet points for consistency, streamlined instructions for enhancing the Port User blueprint, and removed redundant sections to enhance readability.
1 parent d47e1e1 commit 47c9ecf

File tree

1 file changed

+8
-47
lines changed

1 file changed

+8
-47
lines changed

docs/guides/all/map-git-users-to-port-accounts.md

Lines changed: 8 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ import TabItem from '@theme/TabItem';
1010
This guide demonstrates how to automatically map Git users to existing Port user accounts based on email addresses.
1111

1212
Once implemented, users will be able to:
13-
- Maintain a complete inventory of all Git users in your organization within Port
14-
- Automatically link Git users to their corresponding Port user accounts for seamless integration
15-
- Provide visibility into which Git users have Port accounts and which don't
13+
- Maintain a complete inventory of all Git users in your organization within Port.
14+
- Automatically link Git users to their corresponding Port user accounts for seamless integration.
15+
- Provide visibility into which Git users have Port accounts and which ones do not.
1616

1717
## Prerequisites
1818

@@ -26,49 +26,18 @@ This guide assumes the following:
2626

2727
## Set up data model
2828

29-
To establish relationships between Git users and Port user accounts, we need to enhance the Port User blueprint to add relations to the Git user blueprints.
29+
The relations between Git users and Port users are created automatically when we install the relevant Git integrations.
30+
If you haven't installed them yet, please do so first.
3031

31-
<h3> Enhance the Port User blueprint</h3>
32-
33-
Now we need to enhance the Port User blueprint to add relations to the Git user blueprints and mirror properties to display Git information.
32+
<h3>Add mirror properties to the Port User blueprint</h3>
3433

3534
1. Go to the [data model](https://app.getport.io/settings/data-model) page of your portal.
3635

3736
2. Find the `User` blueprint and click on it.
3837

3938
3. Click on the `Edit JSON` button in the top right corner.
4039

41-
4. Add the following relations to the `relations` object (add only the ones relevant to your Git integrations):
42-
43-
<details>
44-
<summary><b>Port User blueprint relations (Click to expand)</b></summary>
45-
46-
```json showLineNumbers
47-
"relations": {
48-
"githubUser": {
49-
"title": "GitHub User",
50-
"target": "githubUser",
51-
"required": false,
52-
"many": false
53-
},
54-
"gitlabUser": {
55-
"title": "GitLab User",
56-
"target": "gitlabMember",
57-
"required": false,
58-
"many": false
59-
},
60-
"azureDevopsUser": {
61-
"title": "Azure DevOps User",
62-
"target": "azureDevopsMember",
63-
"required": false,
64-
"many": false
65-
}
66-
}
67-
```
68-
69-
</details>
70-
71-
5. Add mirror properties to display Git user information:
40+
4. Add the following mirror properties to the `mirrorProperties` object to display Git user information:
7241

7342
<details>
7443
<summary><b>Port User blueprint mirror properties (Click to expand)</b></summary>
@@ -92,7 +61,7 @@ Now we need to enhance the Port User blueprint to add relations to the Git user
9261

9362
</details>
9463

95-
6. Click on `Save` to update the blueprint.
64+
5. Click on `Save` to update the blueprint.
9665

9766
:::info Additional mirror properties
9867
You can add more mirror properties to display other Git user attributes or customize which properties are most relevant for your organization. Only add the mirror properties for the Git platforms you're using.
@@ -257,8 +226,6 @@ To update the Azure DevOps integration mapping, follow the steps below:
257226

258227
To ensure new Port users are automatically mapped to their corresponding Git user accounts when a new Port user is created, we'll create an automation that triggers when a new Port user is created.
259228

260-
Follow the steps below to create the automation:
261-
262229
1. Go to the [Automations](https://app.getport.io/settings/automations) page of your portal.
263230

264231
2. Click on `+ Automation`.
@@ -344,7 +311,6 @@ Follow the steps below to create the automation:
344311

345312
5. Click `Save` to create the automation.
346313

347-
348314
## Let's test it!
349315

350316
1. Go to your [Software catalog](https://app.getport.io/catalog) page
@@ -355,8 +321,3 @@ Follow the steps below to create the automation:
355321

356322
4. Check that the relationship is established automatically for new Git users.
357323

358-
359-
## Conclusion
360-
361-
You've successfully set up automatic mapping between Git users and Port user accounts.
362-

0 commit comments

Comments
 (0)