Skip to content
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.

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

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

Merged
merged 3 commits into from
Dec 29, 2023

Conversation

ch3yne
Copy link
Contributor

@ch3yne ch3yne commented Dec 27, 2023

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

@ch3yne ch3yne self-assigned this Dec 27, 2023
toc_max_heading_level: 5
license: 'Copyright 2023 Datastrato Pvt Ltd. This software is licensed under the Apache License version 2.'
---

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

DONE

docs/webui.md Outdated
gravitino.authenticator = simple
```

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

DONE

docs/webui.md Outdated

## Initial page

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

web UI, not webUI.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

web UI, not webUI.

DONE

docs/webui.md Outdated

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

#### 1. Show metalake details
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

DONE

docs/webui.md Outdated

> Required properties in various providers

- hive
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize the first letter for Hive, Iceberg, etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize the first letter for Hive, Iceberg, etc.

DONE

docs/webui.md Outdated

- hive

Following: [Apache Hive catalog](apache-hive-catalog)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Follow the Hive catalog doc...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Follow the Hive catalog doc...

DONE


### Schema

Under Construction...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Is the following format acceptable?
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

@justinmclean justinmclean left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor things to correct.

docs/webui.md Outdated Show resolved Hide resolved
docs/webui.md Outdated Show resolved Hide resolved
docs/webui.md Outdated Show resolved Hide resolved
docs/webui.md Outdated Show resolved Hide resolved
docs/webui.md Outdated
gravitino.authenticator = oauth
```

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will display is better but we need to avoid using will

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use active voice

docs/webui.md Outdated Show resolved Hide resolved
docs/webui.md Outdated Show resolved Hide resolved
docs/webui.md Outdated Show resolved Hide resolved
docs/webui.md Outdated Show resolved Hide resolved
docs/webui.md Outdated Show resolved Hide resolved
@ch3yne ch3yne force-pushed the add-webui-doc branch 3 times, most recently from 7e30d03 to f676ad4 Compare December 28, 2023 04:09
@ch3yne
Copy link
Contributor Author

ch3yne commented Dec 28, 2023

A few minor things to correct.

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

docs/webui.md Outdated
gravitino.authenticator = simple
```

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need for "directly"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE

docs/webui.md Outdated

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

At the top-right, displays the current version.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE

docs/webui.md Outdated

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

creating a catalog.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE

docs/webui.md Outdated
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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE

docs/webui.md Outdated

![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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Security](security.md)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE

docs/webui.md Outdated
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"the graphical interface is accessible..."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE

docs/webui.md Outdated
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"For the details, please..."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE

docs/webui.md Outdated
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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE

docs/webui.md Outdated
gravitino.authenticator = simple
```

Set the configuration parameter for `gravitino.authenticator` to `simple`, the web UI displays the homepage (Metalakes).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove "for".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE

docs/webui.md Outdated
gravitino.authenticator = oauth
```

Set the configuration parameter for `gravitino.authenticator` to `oauth`, the web UI directly displays the login page.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE

jerryshao
jerryshao previously approved these changes Dec 29, 2023
docs/webui.md Outdated
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**)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@jerryshao jerryshao Dec 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jerryshao jerryshao added need backport Issues that need to backport to another branch branch-0.3 labels Dec 29, 2023
@jerryshao jerryshao merged commit 886235a into apache:main Dec 29, 2023
4 checks passed
github-actions bot pushed a commit that referenced this pull request Dec 29, 2023
### 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch-0.3 need backport Issues that need to backport to another branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc improve: webUI operation manual
3 participants