Skip to content

Commit 083a651

Browse files
authored
docs(developer): update the Resources Module article (#519)
1 parent 3f2ac6e commit 083a651

File tree

2 files changed

+20
-12
lines changed

2 files changed

+20
-12
lines changed
-153 KB
Loading

src/content/docs/developer/modules/ui-modules/profile-resources-menu.mdx

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,32 @@
11
---
22
title: Resources Module
3-
description: Create an additional panel in the project owner's resources
3+
description: Create a new item in the Extensions section of the user's profile
44
slug: developer/crowdin-apps-module-profile-resources-menu
55
sidebar:
66
order: 13
77
label: Resources
88
---
99

10+
import { Aside } from '@astrojs/starlight/components';
1011
import { Image } from 'astro:assets';
1112
import resources from '!/developer/module_resources.png';
1213

13-
The module allows the creation of an additional panel in the project owner's resources.
14+
The module allows the creation of a new item in the **Extensions** section of the user's profile.
1415

1516
<Image src={resources} alt="Resources Module" />
1617

18+
<Aside>
19+
This module is available only for Crowdin.
20+
</Aside>
21+
1722
## Access
1823

1924
You can grant access to this module to one of the following user categories:
2025

21-
For Crowdin:
22-
2326
* Only me (i.e., project owner)
2427
* All project members
2528
* Selected users
2629

27-
For Crowdin Enterprise:
28-
29-
* Only organization admins
30-
* All users in the organization projects
31-
* Selected users
32-
3330
## Structure
3431

3532
```json title="manifest.json"
@@ -39,7 +36,9 @@ For Crowdin Enterprise:
3936
{
4037
"key": "your-module-key",
4138
"name": "Module name",
42-
"url": "/resource-page"
39+
"url": "/resource-page",
40+
"icon": "/images/icon.png",
41+
"environments": "crowdin"
4342
}
4443
]
4544
}
@@ -74,11 +73,20 @@ For Crowdin Enterprise:
7473
<p><strong>Description:</strong> The relative URL to the content page of the module that will be integrated into the Crowdin UI.</p>
7574
</td>
7675
</tr>
76+
<tr>
77+
<td><code>icon</code></td>
78+
<td>
79+
<p><strong>Type:</strong> <code>string</code></p>
80+
<p><strong>Required:</strong> yes</p>
81+
<p><strong>Description:</strong> The relative URL to the icon that will be displayed in the Crowdin UI.<br/>
82+
The recommended resolution is 24x24 pixels.</p>
83+
</td>
84+
</tr>
7785
<tr>
7886
<td><code class="whitespace-nowrap">environments</code></td>
7987
<td>
8088
<p><strong>Type:</strong> <code>string</code></p>
81-
<p><strong>Allowed values:</strong> <code>crowdin</code>, <code>crowdin-enterprise</code></p>
89+
<p><strong>Allowed values:</strong> <code>crowdin</code></p>
8290
<p><strong>Description:</strong> Set of environments where a module could be installed.<br/>
8391
This parameter is needed for cross-product applications.</p>
8492
</td>

0 commit comments

Comments
 (0)