Skip to content

Commit 7d48099

Browse files
dklposr-remsha
dklpo
and
sr-remsha
authored
Chore: Multiple small updates (#351)
Co-authored-by: sr-remsha <sr.remsha@gmail.com> Co-authored-by: sr-remsha <46220620+sr-remsha@users.noreply.github.com>
1 parent 1031979 commit 7d48099

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+621
-250
lines changed

‎docs/tutorials/3.admin/approvals-application-publications.md‎

Lines changed: 40 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,82 +2,85 @@
22

33
## About Application Publications
44

5-
DIAL offers [API](https://dialx.ai/dial_api#tag/Publications/operation/createPublication) for creating publication requests for resources, including applications.
5+
DIAL users can publish their created apps to make them available to other users. Published apps become available in the public folder and can be accessible to users based on the access rules defined in the publication request. You can access published apps in [Assets/Applications](/docs/tutorials/3.admin/assets-applications.md) section. Published apps can be unpublished by DIAL admin or other DIAL users.
66

7-
In this section, an admin can review application properties, configuration and related files prior the approval of the publication request.
7+
Apps can be published/unpublished using DIAL Core [API](https://dialx.ai/dial_api#tag/Publications/operation/createPublication) or in [DIAL Chat](/docs/tutorials/0.user-guide.md#publications).
88

9-
> * Refer to [Publications](/docs/platform/7.collaboration-intro.md#publication) to learn more about publications in DIAL.
10-
> * Refer to [Publications](/docs/tutorials/0.user-guide.md#publications) in Chat user guide to learn more about end-to-end flow.
9+
In this section of the DIAL Admin panel, admins can access and approve or decline apps publication requests.
1110

11+
> * Refer to [Publications](/docs/platform/7.collaboration-intro.md#publication) to learn more about publications in DIAL.
12+
> * Refer to [DIAL Chat User Guide](/docs/tutorials/0.user-guide.md#publications) to learn about the publication process from the perspective of a DIAL Chat end-user.
1213
1314
## Application Publications List
1415

15-
The Application Publications screen shows all apps that end-users have submitted for publication using the DIAL API.
16+
The Application Publications screen shows all publish/unpublish requests submitted by end-users using the DIAL API.
1617

1718
![ ](img/93.png)
1819

1920
##### Application Publications Grid
2021

21-
| Field | Definition |
22+
| Field | Definition |
2223
|------------------|---------------------------------------------------------------------------------------------------------------------------------|
23-
| **Name** | The title of the submitted publication request (not the application). |
24+
| **Name** | The title of the submitted publication request (not the application). |
2425
| **Author** | The user who has submitted the publication request. Can be used to follow up with the creator if something needs clarification. |
25-
| **Created at** | Submission's timestamp. |
26+
| **Created at** | Publication request submission's timestamp. |
27+
2628

29+
## Review Page
2730

28-
## Application Publication Review Page
31+
Click any publication request on the main screen to access the review page. On this page, you can inspect the selected request and decide whether to **Publish**, **Unpublish** or **Decline** it.
2932

30-
In the Application Publications Review page, you can inspect application publication request and decide whether to **Publish** it to marketplace or **Decline** it.
33+
##### Publication Request Controls
3134

32-
##### Top Bar
35+
* **Publish**: Applies to publish requests. Use to approve the request.
36+
* **Unpublish**: Applies to unpublish requests. Use to approve the request and remove the published application from the public folder and make it inaccessible to other users.
37+
* **Decline**: Reject the publish/unpublish request. Prompts you to enter a decline reason that will be sent back to the request author.
3338

34-
* **Publish**: Click Publish to approve the publication request and add application to the [DIAL Marketplace](/docs/tutorials/0.user-guide.md#marketplace), where other users can access it based on the publication rules specified in the publication request.
35-
* **Decline**: Reject the publication request. Prompts you to enter a decline reason that will be sent back to the publication request author.
39+
![](img/publish-toolset.png)
3640

37-
| Field | Definition |
38-
|---------------------|----------------------------------------------------------------------------------------------------------|
39-
| **Runner** | The application runner that is used by this app (shown as a URL). |
40-
| **Author** | Username of the account that created the app publication request. |
41-
| **Create Time** | The publication request's submission timestamp. |
42-
| **Folder Storage** | The path to the file storage folder where the application assets will be saved in case it is published. |
41+
![](img/unpublish-toolset.png)
42+
43+
| Field | Definition |
44+
|--------------------|--------------|
45+
| **Runner** | The application runner that is used by this app (shown as a URL). |
46+
| **Author** | The user who has submitted the publication request. Can be used to follow up with the creator if something needs clarification. |
47+
| **Create Time** | The publication request's submission timestamp. |
48+
| **Folder Storage** | The path to the file storage folder where the application assets will be saved in case it is published. |
4349

4450
![](img/94.png)
4551

4652

47-
## Properties Tab
53+
### Properties Tab
4854

4955
The Properties tab shows the basic information about the app and related access rules.
5056

51-
| Field | Definition |
52-
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
53-
| **Name** | The name of the application that will be rendered in [DIAL Marketplace](/docs/tutorials/0.user-guide.md#marketplace). It must be clear and policy-safe. |
54-
| **Version** | Semantic version of the application (e.g., `0.0.1`) set on the DIAL chat side. |
55-
| **Description** | Summary of app's purpose and capabilities specified by the submitting user. Helps assess app's fit and scope. |
56-
| **Icon** | The application's icon that will be rendered on UI. |
57+
| Field | Definition |
58+
|------------------|-----------|
59+
| **Display Name** | The name of the application that will be rendered in [DIAL Marketplace](/docs/tutorials/0.user-guide.md#marketplace). It must be clear and policy-safe. |
60+
| **Version** | Semantic version of the application (e.g., `0.0.1`) set on the DIAL chat side. |
61+
| **Description** | Summary of app's purpose and capabilities specified by the submitting user. Helps assess app's fit and scope. |
62+
| **Icon** | The application's icon that will be rendered on UI. |
5763
| **Topics** | Tags/categories (e.g., “Text Generation”, “Informational”) used for the app discovery in [DIAL Marketplace](/docs/tutorials/0.user-guide.md#marketplace). |
58-
| **Permissions** | The proposed access rules to the application (e.g., based on user group). Ensure the audience matches intended reach. |
59-
60-
**Controls:**
61-
* **Review structure** opens a modal showing the storage folders tree and apps' folder position in the hierarchy.
62-
* **Compare changes** side-by-side diff of **current vs proposed** permission rules to the app's folder. Use to verify and validate changes in access rules before approving the publication request.
64+
| **Permissions** | The proposed access rules to the published application (e.g., based on user group). Ensure the audience matches intended reach. If rules are not defined, the published resources will be available to all users. <br /> Available Controls:<br /> - **Review structure** opens a modal showing the storage folders tree and apps' folder position in the hierarchy.<br />- **Compare changes** side-by-side diff of **current vs proposed** permission rules to the app's folder. Use to verify and validate changes in access rules before approving the publication request. |
6365

6466
![](img/95.png)
6567

66-
## Parameters Tab
68+
### Parameters Tab
6769

6870
The Parameters tab provides administrators with technical metadata and runtime configuration related to the application.
6971

7072
The content of this tab may vary depending on the app's type and configuration.
7173

74+
![](img/publish-app-params.png)
7275

73-
## Files Tab
76+
### Files Tab
7477

75-
The Files tab you can find a list of application-related assets. This section is empty if the application does not include any files.
78+
In this tab you can find a list of application-related assets. This section is empty if the application does not include any files.
7679

77-
| Field | Definition |
80+
| Field | Definition |
7881
|---------------|----------------------------------------------------------------------------------|
79-
| **Name** | System-generated identifier of the file. |
80-
| **Extension** | File type (e.g., `.json`, `.png`). |
82+
| **Name** | System-generated identifier of the file. |
83+
| **Extension** | File type (e.g., `.json`, `.png`). |
8184
| **Preview** | An action button in the row menu can be used to open the file in a new tab. |
8285
| **Download** | An action button in the row menu can be used to download the file to a local PC. |
8386

‎docs/tutorials/3.admin/approvals-file-publications.md‎

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,53 @@
22

33
## About File Publications
44

5-
DIAL offers [API](https://dialx.ai/dial_api#tag/Publications/operation/createPublication) for creating publication requests for resources, including files. In File Publications, administrators can view and manage publication requests. Files from approved requests are available in [Assets → Files](/docs/tutorials/3.admin/assets-files.md).
5+
DIAL users can leverage DIAL Core API to publish specific files to make them available to other users and apps in the organization. Published files become available in the public folder and can be accessible to users based on the access rules defined in the publication request.
6+
DIAL Core provides [API](https://dialx.ai/dial_api#tag/Publications/operation/createPublication) for creating publication requests for resources, including files.
7+
8+
Files from approved requests are available in [Assets/Files](/docs/tutorials/3.admin/assets-files.md). Published files can be unpublished by DIAL admin or other DIAL users.
69

710
> * Refer to [Publications](/docs/platform/7.collaboration-intro.md#publication) to learn more about publications in DIAL.
811
> * Refer to [User Guide](/docs/tutorials/0.user-guide.md#publications) to learn how to publish resources in DIAL Chat.
912
1013
## File Publications List
1114

12-
In File Publications, you can review all requests to publish files and decide whether to approve or to decline them.
15+
The File Publications List screen shows all publish/unpublish requests submitted by end-users using the DIAL API.
1316

1417
![](img/img_54.png)
1518

16-
1719
##### File Publications Grid
1820

19-
| Column | Definition |
20-
|----------------|---------------------------------------------------------------------------------------------------------------------------------|
21-
| **Name** | A user-friendly name of the file submitted for publication. |
22-
| **Author** | The name of the publication request author. |
23-
| **Created at** | Timestamp when the file was submitted for publication. |
21+
| Column | Definition |
22+
|----------------|--------------------|
23+
| **Name** | The title of the request.|
24+
| **Author** | The username of the request author. |
25+
| **Created at** | Timestamp when the request was submitted. |
2426

2527

2628
## Review Page
2729

28-
When a DIAL Core user submits a file publication request, it appears on the main File Publications screen. Click any request to access the review screen, where you can inspect it and either Publish it into the central Assets store or Decline it (with feedback).
30+
Click any publication request on the main screen to access the review page. On this page, you can inspect the selected request and decide whether to **Publish**, **Unpublish** or **Decline** it.
31+
32+
##### Publication Request Controls
2933

30-
##### Top Bar Controls
34+
On the top bar, you can find the following controls:
3135

32-
* **Publish**: Accept the publication request. This adds the file into the Assets → Prompts folder (under the specified Folder).
33-
* **Decline**: Reject the publication request. Prompts you to enter a decline reason that will be sent back to the publication request author.
36+
* **Publish**: Applies to publish requests. Use to approve the request.
37+
* **Unpublish**: Applies to unpublish requests. Use to approve the request and remove the resource from the public folder and make it inaccessible to other users.
38+
* **Decline**: Reject the publish/unpublish request. Prompts you to enter a decline reason that will be sent back to the request author.
3439

35-
![](img/img_55.png)
40+
![](img/publish-toolset.png)
3641

42+
![](img/unpublish-toolset.png)
3743

38-
| Element | Definition |
39-
|--------------------|----------------------------------------------------------------------------------|
40-
| **Action** | A suggested action. The **Publish** action button is highlighted when review is pending. |
44+
45+
| Element | Definition |
46+
|--------------------|-----------------|
4147
| **Author** | A username of the account that created the file publication request. |
42-
| **Created At** | A timestamp of when the file publication request was submitted for review. |
48+
| **Creation Time** | A timestamp of when the file publication request was submitted for review. |
4349
| **Folder Storage** | The default target folder under [Assets → Files](/docs/tutorials/3.admin/assets-files.md), if published. |
44-
| **File Name** | File display name. |
45-
| **File Extension** | File type/extension (e.g. .pdf, .csv, .docx). |
46-
| **Permissions** | Shows the target folder's place in [folders hierarchy](/docs/tutorials/3.admin/access-management-folders-storage.md) and respective permissions. |
50+
| **Display Name** | File display name. |
51+
| **Extension** | File type/extension (e.g. .pdf, .csv, .docx). |
52+
| **Permissions** | The proposed access rules to the published file (e.g., based on user group). Ensure the audience matches intended reach. If rules are not defined, the published resources will be available to all users. <br /> Available Controls:<br /> - **Review structure** opens a modal showing the storage folders tree and file's folder position in the hierarchy.<br />- **Compare changes** side-by-side diff of **current vs proposed** permission rules to the file's folder. Use to verify and validate changes in access rules before approving the publication request. |
53+
54+
![](img/publish-file.png)

0 commit comments

Comments
 (0)