Skip to content

docs(developer): update the Resources Module article #519

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrii-bodnar merged 1 commit into from
Nov 17, 2025
Merged

docs(developer): update the Resources Module article #519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified src/assets/screenshots/developer/module_resources.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 20 additions & 12 deletions src/content/docs/developer/modules/ui-modules/profile-resources-menu.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,32 @@
---
title: Resources Module
description: Create an additional panel in the project owner's resources
description: Create a new item in the Extensions section of the user's profile
slug: developer/crowdin-apps-module-profile-resources-menu
sidebar:
order: 13
label: Resources
---

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

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

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

<Aside>
This module is available only for Crowdin.
</Aside>

## Access

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

For Crowdin:

* Only me (i.e., project owner)
* All project members
* Selected users

For Crowdin Enterprise:

* Only organization admins
* All users in the organization projects
* Selected users

## Structure

```json title="manifest.json"
Expand All @@ -39,7 +36,9 @@ For Crowdin Enterprise:
{
"key": "your-module-key",
"name": "Module name",
"url": "/resource-page"
"url": "/resource-page",
"icon": "/images/icon.png",
"environments": "crowdin"
}
]
}
Expand Down Expand Up @@ -74,11 +73,20 @@ For Crowdin Enterprise:
<p><strong>Description:</strong> The relative URL to the content page of the module that will be integrated into the Crowdin UI.</p>
</td>
</tr>
<tr>
<td><code>icon</code></td>
<td>
<p><strong>Type:</strong> <code>string</code></p>
<p><strong>Required:</strong> yes</p>
<p><strong>Description:</strong> The relative URL to the icon that will be displayed in the Crowdin UI.<br/>
The recommended resolution is 24x24 pixels.</p>
</td>
</tr>
<tr>
<td><code class="whitespace-nowrap">environments</code></td>
<td>
<p><strong>Type:</strong> <code>string</code></p>
<p><strong>Allowed values:</strong> <code>crowdin</code>, <code>crowdin-enterprise</code></p>
<p><strong>Allowed values:</strong> <code>crowdin</code></p>
<p><strong>Description:</strong> Set of environments where a module could be installed.<br/>
This parameter is needed for cross-product applications.</p>
</td>
Expand Down