Re: [PR] [#5965] subtask(web): ML model support for web UI [gravitino]

[via GitHub]

orenccl commented on code in PR #6025:
URL: https://github.com/apache/gravitino/pull/6025#discussion_r1898531624


##########
docs/webui.md:
##########
@@ -527,19 +575,137 @@ Displays a confirmation dialog, clicking on the `DROP` 
button drops this fileset
 ![delete-fileset](./assets/webui/delete-fileset.png)
 
 ### Topic
+Click the kafka schema tree node on the left sidebar or the schema name link 
in the table cell.
+
+Displays the list topics of the schema.
+
+![list-topics](./assets/webui/list-topics.png)
+
+#### Create topic
+
+Click on the `CREATE TOPIC` button displays the dialog to create a topic.
+
+![create-topic](./assets/webui/create-topic.png)
+
+Creating a topic needs these fields:
+
+1. **Name**(**_required_**): the name of the topic.
+2. **Comment**(_optional_): the comment of the topic.
+3. **Properties**(_optional_): Click on the `ADD PROPERTY` button to add 
custom properties.
+
+#### Show topic details
+
+Click on the action icon <Icon icon='bx:show-alt' fontSize='24' /> in the 
table cell.
+
+You can see the detailed information of this topic in the drawer component on 
the right.
+
+![topic-details](./assets/webui/topic-drawer-details.png)
+
+Click the topic tree node on the left sidebar or the topic name link in the 
table cell.
+
+You can see the detailed information on the right page.
 
 ![topic-details](./assets/webui/topic-details.png)
 
+#### Edit topic
+
+Click on the action icon <Icon icon='mdi:square-edit-outline' fontSize='24' /> 
in the table cell.
+
+Displays the dialog for modifying fields of the selected topic.
+
+![update-topic-dialog](./assets/webui/update-topic-dialog.png)
+
+#### Drop topic
+
+Click on the action icon <Icon icon='mdi:delete-outline' fontSize='24' 
color='red' /> in the table cell.
+
+Displays a confirmation dialog, clicking on the `DROP` button drops this 
fileset.
+
+![delete-topic](./assets/webui/delete-topic.png)
+
+### Model
+Click the model schema tree node on the left sidebar or the schema name link 
in the table cell.
+
+Displays the list model of the schema.
+
+![list-models](./assets/webui/list-models.png)
+
+#### Register model
+
+Click on the `REGISTER MODEL` button displays the dialog to register a model.
+
+![register-model](./assets/webui/register-model.png)
+
+Register a model needs these fields:
+
+1. **Name**(**_required_**): the name of the model.
+2. **Comment**(_optional_): the comment of the model.
+3. **Properties**(_optional_): Click on the `ADD PROPERTY` button to add 
custom properties.
+
+#### Show model details
+
+Click on the action icon <Icon icon='bx:show-alt' fontSize='24' /> in the 
table cell.
+
+You can see the detailed information of this model in the drawer component on 
the right.
+
+![model-details](./assets/webui/model-details.png)
+
+#### Drop model
+
+Click on the action icon <Icon icon='mdi:delete-outline' fontSize='24' 
color='red' /> in the table cell.
+
+Displays a confirmation dialog, clicking on the `DROP` button drops this model.
+
+![delete-model](./assets/webui/delete-model.png)
+
+### Version
+Click the model tree node on the left sidebar or the model name link in the 
table cell.
+
+Displays the list versions of the model.
+
+![list-model-versions](./assets/webui/list-model-versions.png)
+
+#### Link version
+
+Click on the `LINK VERSION` button displays the dialog to link a version.
+
+![link-version](./assets/webui/link-version.png)
+
+Link a version needs these fields:
+
+1. **URI**(**_required_**): the uri of the version.
+2. **Aliases**(**_required_**): the aliases of the version, aliase cannot be 
number or number string.
+3. **Comment**(_optional_): the comment of the model.
+4. **Properties**(_optional_): Click on the `ADD PROPERTY` button to add 
custom properties.
+
+#### Show version details
+
+Click on the action icon <Icon icon='bx:show-alt' fontSize='24' /> in the 
table cell.
+
+You can see the detailed information of this version in the drawer component 
on the right.
+
+![version-details](./assets/webui/version-details.png)
+
+#### Drop version
+
+Click on the action icon <Icon icon='mdi:delete-outline' fontSize='24' 
color='red' /> in the table cell.
+
+Displays a confirmation dialog, clicking on the `DROP` button drops this model.

Review Comment:
   Should be ... drop this version?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@gravitino.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org