You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@paimon.apache.org by ni...@apache.org on 2024/07/10 11:25:57 UTC
(paimon-webui) 11/11: [Improvement] Optimize quick start documentation (#493)
This is an automated email from the ASF dual-hosted git repository.
nicholasjiang pushed a commit to branch branch-0.1
in repository https://gitbox.apache.org/repos/asf/paimon-webui.git
commit 3dcd2437a19d6f4e2ef309b744fa00b41116e247
Author: s7monk <34...@users.noreply.github.com>
AuthorDate: Wed Jul 10 19:20:04 2024 +0800
[Improvement] Optimize quick start documentation (#493)
---
docs/.vitepress/config.mts | 7 ++++++-
docs/index.md | 32 +++++++++++++++-----------------
docs/public/img/img_1.png | Bin 116184 -> 276810 bytes
docs/public/img/img_2.png | Bin 140666 -> 446134 bytes
docs/src/guide/about.md | 31 +++++++++++++++----------------
docs/src/guide/quick-start.md | 39 +++++++++++++++++++--------------------
6 files changed, 55 insertions(+), 54 deletions(-)
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
index 6b743643..536bfab0 100644
--- a/docs/.vitepress/config.mts
+++ b/docs/.vitepress/config.mts
@@ -3,6 +3,7 @@ import { defineConfig } from 'vitepress'
export default defineConfig({
title: "Paimon Web",
description: "Web UI for Apache Paimon",
+
themeConfig: {
logo: "/favicon_blue.svg",
nav: [
@@ -28,6 +29,10 @@ export default defineConfig({
socialLinks: [
{ icon: 'github', link: 'https://github.com/apache/paimon-webui' }
- ]
+ ],
+
+ footer: {
+ copyright: 'Copyright © 2024 The Apache Software Foundation. Apache Paimon, Paimon, and its feather logo are trademarks of The Apache Software Foundation.'
+ }
}
})
diff --git a/docs/index.md b/docs/index.md
index 0a7b7555..09231600 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,22 +1,20 @@
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
+---
+license: |
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
+ https://www.apache.org/licenses/LICENSE-2.0
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
----
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
layout: home
hero:
diff --git a/docs/public/img/img_1.png b/docs/public/img/img_1.png
index c1409244..a507eb72 100644
Binary files a/docs/public/img/img_1.png and b/docs/public/img/img_1.png differ
diff --git a/docs/public/img/img_2.png b/docs/public/img/img_2.png
index 1a3c9338..85b14500 100644
Binary files a/docs/public/img/img_2.png and b/docs/public/img/img_2.png differ
diff --git a/docs/src/guide/about.md b/docs/src/guide/about.md
index ba6c4a0d..41ca971a 100644
--- a/docs/src/guide/about.md
+++ b/docs/src/guide/about.md
@@ -1,21 +1,20 @@
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
+---
+license: |
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
+ https://www.apache.org/licenses/LICENSE-2.0
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+---
# About Paimon Web
Paimon Web, the Web UI for Apache Paimon, enhances the management of Paimon table information through advanced visualization capabilities.
diff --git a/docs/src/guide/quick-start.md b/docs/src/guide/quick-start.md
index 0d6b7fcb..e037ce7b 100644
--- a/docs/src/guide/quick-start.md
+++ b/docs/src/guide/quick-start.md
@@ -1,21 +1,20 @@
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
+---
+license: |
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+---
# Quick Start
This brief tutorial will guide you through the steps to deploy and utilize Paimon Web effectively.
@@ -66,7 +65,7 @@ These changes will ensure that Paimon Web runs smoothly with your specific setup
To configure the environment for your application, follow these steps:
-1. **Set Environment Variables**: Modify the `env.sh` script located in the `bin` directory. You'll need to configure variables such as `FLINK_HOME`, `ACTION_JAR_PATH`, and `JAVA_HOME`.
+1. **Set Environment Variables**: Modify the `env.sh` script located in the `bin` directory. You can configure variables such as `FLINK_HOME`, `ACTION_JAR_PATH`, and `JAVA_HOME`.
2. **Optional Settings**: If you are not using the CDC (Change Data Capture) function, there is no need to configure `FLINK_HOME` and `ACTION_JAR_PATH`.
This setup will prepare your system to properly run the application with the necessary configurations.
@@ -85,7 +84,7 @@ To launch the service, follow these steps:
```shell
[root@paimon ~]# bin/start.sh
```
-2. **Access the Web Interface**: Open a web browser and enter the URL `http://{ip}:{port}` to navigate to the Paimon web page.
+2. **Access the Web Interface**: Open a web browser and enter the URL `http://{ip}:{port}/ui/login` to navigate to the Paimon web page.
Ensure you replace `{ip}` and `{port}` with the actual ip address and port number where the service is running.