[#1469] improvement(doc): Add doc about webUI operation #1270

ch3yne · 2023-12-27T07:30:47Z

What changes were proposed in this pull request?

Compose documentation for the webUI, detailing the procedures for CRUD operations.

Why are the changes needed?

Fix: #1269

Does this PR introduce any user-facing change?

N/A

How was this patch tested?

N/A

jerryshao · 2023-12-27T11:15:18Z

docs/webui.md

+toc_max_heading_level: 5
+license: 'Copyright 2023 Datastrato Pvt Ltd. This software is licensed under the Apache License version 2.'
+---
+


Can you please add a simple paragraph to introduce the content of this doc in a general view?

Can you please add a simple paragraph to introduce the content of this doc in a general view?

DONE

jerryshao · 2023-12-27T11:17:50Z

docs/webui.md

+gravitino.authenticator = simple
+```
+
+If the configuration parameter for `gravitino.authenticator` is set to `simple`, the webUI will directly display the homepage (Metalakes).


Don't use the future tense, just using the simple tense: the web UI directly displays the homepage...

Don't use the future tense, just using the simple tense: the web UI directly displays the homepage...

DONE

jerryshao · 2023-12-27T11:18:03Z

docs/webui.md

+
+## Initial page
+
+The webUI homepage displaying in Gravitino depends on the configuration parameter for OAuth mode, see the details in [Security](security.md).


web UI, not webUI.

web UI, not webUI.

DONE

jerryshao · 2023-12-27T11:20:41Z

docs/webui.md

+
+![metalake-actions](assets/webui/metalake-actions.png)
+
+#### 1. Show metalake details


I think you can remove this "1. ", "2. ", "3. " here and below.

I think you can remove this "1. ", "2. ", "3. " here and below.

DONE

jerryshao · 2023-12-27T11:21:37Z

docs/webui.md

+
+> Required properties in various providers
+
+- hive


Capitalize the first letter for Hive, Iceberg, etc.

Capitalize the first letter for Hive, Iceberg, etc.

DONE

jerryshao · 2023-12-27T11:22:00Z

docs/webui.md

+
+- hive
+
+Following: [Apache Hive catalog](apache-hive-catalog)


Follow the Hive catalog doc...

Follow the Hive catalog doc...

DONE

jerryshao · 2023-12-27T11:23:30Z

docs/webui.md

+
+### Schema
+
+Under Construction...


You'd better have a basic list view and detailed view for schema and table.

You'd better have a basic list view and detailed view for schema and table.

Is the following format acceptable?

Yes, it would be better you also have screenshots to show the schemas and tables.

justinmclean

A few minor things to correct.

docs/webui.md

justinmclean · 2023-12-27T22:38:34Z

docs/webui.md

+gravitino.authenticator = oauth
+```
+
+If the configuration parameter for `gravitino.authenticator` is set to `oauth`, the web UI will directly display the login page.


will display is better but we need to avoid using will

use active voice

docs/webui.md

ch3yne · 2023-12-28T04:14:07Z

A few minor things to correct.

I have revised the entire content according to the suggestions. Please check it again. Thank you very much!

justinmclean · 2023-12-28T05:50:34Z

docs/webui.md

+gravitino.authenticator = simple
+```
+
+Set the configuration parameter for `gravitino.authenticator` to `simple`, the web UI directly displays the homepage (Metalakes).


no need for "directly"

justinmclean · 2023-12-28T05:57:22Z

docs/webui.md

+
+![webui-metalakes-simple](assets/webui/metalakes-simple.png)
+
+At the top-right, displays the current version.


At the top-right, the UI displays the current Gravitino version.

justinmclean · 2023-12-28T06:03:43Z

docs/webui.md

+
+Clicking on a metalake name in the table views catalogs in a metalake.
+
+If this is the first time, it shows no data until after creating catalog.


creating a catalog.

jerryshao · 2023-12-28T07:08:03Z

docs/webui.md

+More features are under development. For detailed capabilities, please refer to the [Manage metadata using Gravitino](manage-metadata-using-gravitino.md) document.
+:::
+
+[Build](how-to-build#quick-start) and [deploy](getting-started#getting-started-locally) the Gravitino Web UI and open it in a browser at [http://localhost:8090](http://localhost:8090).


The url is not always "http://localhost:8090", it depends on how users configure gravitino host and port, I can think you can write to

open it in a browser at `http://<gravitino-host>:<gravitino-port>`, by default is [http://localhost:8090](http://localhost:8090).

jerryshao · 2023-12-28T07:09:32Z

docs/webui.md

+
+![webui-login-with-oauth](assets/webui/login-with-oauth.png)
+
+1. Enter the values corresponding to your specific configuration. For detailed instructions, please refer to [Security](security).


[Security](security.md)

jerryshao · 2023-12-28T09:51:18Z

docs/webui.md

+import Tabs from '@theme/Tabs'
+import TabItem from '@theme/TabItem'
+
+This document primarily outlines how users can manage metadata within Gravitino using the web UI, the graphical interface accessible through a web browser as an alterative to writing code or using the REST interface.


"the graphical interface is accessible..."

jerryshao · 2023-12-28T09:52:26Z

docs/webui.md

+Currently, you can integrate [OAuth settings](security.md) to view, add, modify, and delete metalakes, create catalogs, and view catalogs, schemas, and tables, among other functions.
+
+:::caution
+More features are under development. For detailed capabilities, please refer to the [Manage metadata using Gravitino](manage-metadata-using-gravitino.md) document.


"For the details, please..."

jerryshao · 2023-12-28T09:55:32Z

docs/webui.md

+More features are under development. For detailed capabilities, please refer to the [Manage metadata using Gravitino](manage-metadata-using-gravitino.md) document.
+:::
+
+[Build](how-to-build#quick-start) and [deploy](getting-started#getting-started-locally) the Gravitino Web UI and open it in a browser at `http://<gravitino-host>:<gravitino-port>`, by default is [http://localhost:8090](http://localhost:8090).


Add ".md" suffix to all the links here and below, like "how-to-build.md#quick-start"

jerryshao · 2023-12-28T09:56:11Z

docs/webui.md

+gravitino.authenticator = simple
+```
+
+Set the configuration parameter for `gravitino.authenticator` to `simple`, the web UI displays the homepage (Metalakes).


remove "for".

jerryshao · 2023-12-28T09:56:38Z

docs/webui.md

+gravitino.authenticator = oauth
+```
+
+Set the configuration parameter for `gravitino.authenticator` to `oauth`, the web UI directly displays the login page.


Also here remove "for". And remove "directly" here.

jerryshao · 2023-12-29T08:39:30Z

docs/webui.md

 3. **Provider**(**_required_**): `hive`/`iceberg`/`mysql`/`postgresql`
 4. **Comment**(_optional_): the comment of this catalog
-5. **Properties**(**specific provider inculdes required fileds**)
+5. **Properties**(**specific provider included required fields**)


@ch3yne what's the meaning of this sentence, I cannot follow it.

each `provider` must fill in the required property fields specifically.

### What changes were proposed in this pull request? Compose documentation for the webUI, detailing the procedures for CRUD operations. ### Why are the changes needed? Fix: #1269 ### Does this PR introduce _any_ user-facing change? N/A ### How was this patch tested? N/A

add doc for webui

213ad83

ch3yne requested a review from jerryshao December 27, 2023 07:30

ch3yne self-assigned this Dec 27, 2023

jerryshao reviewed Dec 27, 2023

View reviewed changes

justinmclean reviewed Dec 27, 2023

View reviewed changes

ch3yne force-pushed the add-webui-doc branch 3 times, most recently from 7e30d03 to f676ad4 Compare December 28, 2023 04:09

justinmclean reviewed Dec 28, 2023

View reviewed changes

jerryshao reviewed Dec 28, 2023

View reviewed changes

improve the doc for web ui

3d761cf

ch3yne force-pushed the add-webui-doc branch from 745cc56 to 3d761cf Compare December 29, 2023 03:41

jerryshao previously approved these changes Dec 29, 2023

View reviewed changes

jerryshao reviewed Dec 29, 2023

View reviewed changes

improve the doc for web ui

9e4017b

ch3yne dismissed jerryshao’s stale review via 9e4017b December 29, 2023 08:50

jerryshao approved these changes Dec 29, 2023

View reviewed changes

jerryshao added need backport Issues that need to backport to another branch branch-0.3 labels Dec 29, 2023

jerryshao merged commit 886235a into apache:main Dec 29, 2023
4 checks passed


		## Initial page

		The webUI homepage displaying in Gravitino depends on the configuration parameter for OAuth mode, see the details in [Security](security.md).


		![metalake-actions](assets/webui/metalake-actions.png)

		#### 1. Show metalake details


		![webui-metalakes-simple](assets/webui/metalakes-simple.png)

		At the top-right, displays the current version.


		Clicking on a metalake name in the table views catalogs in a metalake.

		If this is the first time, it shows no data until after creating catalog.


		![webui-login-with-oauth](assets/webui/login-with-oauth.png)

		1. Enter the values corresponding to your specific configuration. For detailed instructions, please refer to [Security](security).

[#1469] improvement(doc): Add doc about webUI operation #1270

[#1469] improvement(doc): Add doc about webUI operation #1270

Conversation

ch3yne commented Dec 27, 2023

What changes were proposed in this pull request?

Why are the changes needed?

Does this PR introduce any user-facing change?

How was this patch tested?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justinmclean left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ch3yne commented Dec 28, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerryshao Dec 29, 2023 • edited Loading

Choose a reason for hiding this comment

jerryshao Dec 29, 2023 •

edited

Loading