You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@kyuubi.apache.org by "zwangsheng (via GitHub)" <gi...@apache.org> on 2023/04/26 06:10:18 UTC

[GitHub] [kyuubi] zwangsheng opened a new pull request, #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

zwangsheng opened a new pull request, #4775:
URL: https://github.com/apache/kyuubi/pull/4775

   <!--
   Thanks for sending a pull request!
   
   Here are some tips for you:
     1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/CONTRIBUTING.html
     2. If the PR is related to an issue in https://github.com/apache/kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
     3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
   -->
   
   ### _Why are the changes needed?_
   <!--
   Please clarify why the changes are needed. For instance,
     1. If you add a feature, you can talk about the use case of it.
     2. If you fix a bug, you can clarify why it is a bug.
   -->
   Close #4761
   
   ### _How was this patch tested?_
   - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
   
   - [ ] Add screenshots for manual tests if appropriate
   
   - [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request
   


-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184584969


##########
docs/contributing/code/building.md:
##########
@@ -91,3 +91,10 @@ The `fast` profile helps to significantly reduce build time, which is useful for
 build/mvn clean package -Pfast
 ```
 
+## Build with Web UI
+
+The Kyuubi Release 1.7.1 and earlier does not include the Web UI module, you should build Kyuubi Binary from master branch.

Review Comment:
   Which version does this feature get involved in? 1.7.1 or 1.8.0



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184576883


##########
docs/contributing/code/building.md:
##########
@@ -91,3 +91,12 @@ The `fast` profile helps to significantly reduce build time, which is useful for
 build/mvn clean package -Pfast
 ```
 
+## Build with Web UI
+
+The Kyuubi Release 1.7.1 and earlier does not include the Web UI module, you should build Kyuubi Binary from master branch.

Review Comment:
   ```suggestion
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] zwangsheng commented on pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "zwangsheng (via GitHub)" <gi...@apache.org>.
zwangsheng commented on PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#issuecomment-1694878794

   > The text appears to be more colloquial and is way from the level of formal docs. It still requires further refinement to avoid redundant content and colloquial expressions.
   
   Thanks for reviewing this. I will do further improve.


-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] bowenliang123 commented on pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "bowenliang123 (via GitHub)" <gi...@apache.org>.
bowenliang123 commented on PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#issuecomment-1694899389

   Thanks for the response. I would suggest to do the following polishment,
   1. 3. use objective descriptions over subjective ones, e.g.`It's suggested. When ...` over `If you want ....`
   2. prevent repeating phases, e.g. recommendations for pnpm
   3. provide decisive suggestions to related descriptions and discussion, e.g. concise  code samples for using pnpm following the recommendation


-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1177545381


##########
docs/deployment/web_ui.md:
##########
@@ -0,0 +1,42 @@
+<!--
+- 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.
+-->
+
+# Deploy Kyuubi Web UI
+
+> Notice. The Kyuubi Web UI still in development, changes to code, functionality, and interface may occur at any time.
+
+## Build Kyuubi Binary with Web UI
+
+The Kyuubi Release 1.7.1 and earlier does not include the Web UI module, you should build Kyuubi Binary from master branch.
+
+```shell
+${KYUUBI_SOURCE_CODE}/build/dist [other args your want] --web-ui
+```
+
+See more details in `${KYUUBI_HOME}/build/dist` script.

Review Comment:
   move it to building.md



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] pan3793 commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "pan3793 (via GitHub)" <gi...@apache.org>.
pan3793 commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1177429632


##########
docs/deployment/web_ui.md:
##########
@@ -0,0 +1,42 @@
+<!--
+- 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.
+-->
+
+# Deploy Kyuubi Web UI
+
+> Notice. The Kyuubi Web UI still in development, changes to code, functionality, and interface may occur at any time.
+
+## Build Kyuubi Binary with Web UI
+
+The Kyuubi Release 1.7.1 and earlier does not include the Web UI module, you should build Kyuubi Binary from master branch.
+
+```shell
+${KYUUBI_SOURCE_CODE}/build/dist [other args your want] --web-ui
+```
+
+See more details in `${KYUUBI_HOME}/build/dist` script.
+
+## Run Kyuubi Server with Web UI
+
+```shell
+${KYUUBI_BINARY}/bin/kyuubi start
+```
+
+Then, you can access Kyuubi Web at `http://0.0.0.0:10099/ui/`
+
+## Separate Deploy Kyuubi Web UI
+
+Still in progress.

Review Comment:
   Remove this part, it's not likely allow to deploy UI separately officially.



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#issuecomment-1526881571

   For a non-programming API, we do not need to add notices like experiential or something else. It breaks nothing in feature releases.


-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

Re: [PR] [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI [kyuubi]

Posted by "zwangsheng (via GitHub)" <gi...@apache.org>.
zwangsheng closed pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI
URL: https://github.com/apache/kyuubi/pull/4775


-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] pan3793 commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "pan3793 (via GitHub)" <gi...@apache.org>.
pan3793 commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1177428503


##########
docs/deployment/web_ui.md:
##########
@@ -0,0 +1,42 @@
+<!--
+- 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.
+-->
+
+# Deploy Kyuubi Web UI
+
+> Notice. The Kyuubi Web UI still in development, changes to code, functionality, and interface may occur at any time.
+
+## Build Kyuubi Binary with Web UI
+
+The Kyuubi Release 1.7.1 and earlier does not include the Web UI module, you should build Kyuubi Binary from master branch.
+
+```shell
+${KYUUBI_SOURCE_CODE}/build/dist [other args your want] --web-ui
+```
+
+See more details in `${KYUUBI_HOME}/build/dist` script.
+
+## Run Kyuubi Server with Web UI
+
+```shell
+${KYUUBI_BINARY}/bin/kyuubi start
+```
+
+Then, you can access Kyuubi Web at `http://0.0.0.0:10099/ui/`

Review Comment:
   ```suggestion
   Access the experimental Kyuubi Web UI at `http://0.0.0.0:10099/ui/`
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184581470


##########
docs/contributing/code/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]
+2. Install [nodejs](https://nodejs.org/en/)[Recommend 18.x.x]
+
+## Install Dependencies
+
+```shell
+cd ${KYUUBI_SOURCE_CODE}/kyuubi-server/web-ui
+npm install
+```
+
+## Develop
+
+Notice:
+
+Before you start the Web UI project, please make sure the Kyuubi server has been started.
+
+Kyuubi Web UI will proxy the requests to Kyuubi server, with the default endpoint path to`http://localhost:10099`. Modify `VITE_APP_DEV_WEB_URL` in `.env.development` for customizing targeted endpoint path.
+
+#### Why proxy to http://localhost:10099
+
+Current Kyuubi server binds on `http://0.0.0.0:10099` in case you are running Kyuubi server in macOS or Windows(If in Linux, you should config Kyuubi server `kyuubi.frontend.rest.bind.host=0.0.0.0`, or change `VITE_APP_DEV_WEB_URL` in `.env.development`).
+
+```shell
+npm run dev
+```
+
+You can access Kyuubi Web UI at `http://localhost:9090/ui`
+
+### Build Project
+
+```shell
+npm run build
+```
+
+### Code Style
+
+Usually after you modify the code, you need to perform code formatting operations to ensure that the code in the project is the same style.

Review Comment:
   `Usually`? Is the style so easy to break?



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] zwangsheng commented on pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "zwangsheng (via GitHub)" <gi...@apache.org>.
zwangsheng commented on PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#issuecomment-1705137711

   Thanks for your suggestion, made the modification. If there's anything wrong, please let me know.


-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] pan3793 commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "pan3793 (via GitHub)" <gi...@apache.org>.
pan3793 commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1177433148


##########
docs/develop_tools/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Develop Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]
+2. Install [nodejs](https://nodejs.org/en/)[Recommend 16.x.x]
+
+## Install Dependencies
+
+```shell
+cd ${KYUUBI_SOURCE_CODE}/kyuubi-server/web-ui
+npm install
+```
+
+## Develop
+
+Notice:
+
+Before you start the Web UI project, please make sure the Kyuubi server has been started.
+
+Kyuubi Web UI will proxy the requests to Kyuubi server,  with the default endpoint path to`http://localhost:10099`. Modify `VITE_APP_DEV_WEB_URL` in `.env.development` for customizing targeted endpoint path.
+
+#### Why proxy to http://localhost:10099
+
+Current kyuubi server binds on `http://0.0.0.0:10099` in case you are running kyuubi server in MacOS or Windows(If in linux, you should config kyuubi server `kyuubi.frontend.rest.bind.host=0.0.0.0`, or change `VITE_APP_DEV_WEB_URL` in `.env.development`).

Review Comment:
   capitalize the words "Kyuubi" "Linux" as "Windows" does. And "macOS", not "MacOS"



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1177543040


##########
docs/develop_tools/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Develop Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]
+2. Install [nodejs](https://nodejs.org/en/)[Recommend 16.x.x]
+
+## Install Dependencies
+
+```shell
+cd ${KYUUBI_SOURCE_CODE}/kyuubi-server/web-ui
+npm install
+```
+
+## Develop
+
+Notice:
+
+Before you start the Web UI project, please make sure the Kyuubi server has been started.
+
+Kyuubi Web UI will proxy the requests to Kyuubi server,  with the default endpoint path to`http://localhost:10099`. Modify `VITE_APP_DEV_WEB_URL` in `.env.development` for customizing targeted endpoint path.
+
+#### Why proxy to http://localhost:10099
+
+Current kyuubi server binds on `http://0.0.0.0:10099` in case you are running kyuubi server in MacOS or Windows(If in linux, you should config kyuubi server `kyuubi.frontend.rest.bind.host=0.0.0.0`, or change `VITE_APP_DEV_WEB_URL` in `.env.development`).
+
+```shell
+npm run dev
+```
+
+You can access Kyuubi Web UI with `http://localhost:9090/ui`
+
+### Build Project
+
+```shell
+npm run build
+```
+
+### Code Format

Review Comment:
   What is the code style we derived from currently?



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184580884


##########
docs/contributing/code/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]
+2. Install [nodejs](https://nodejs.org/en/)[Recommend 18.x.x]
+
+## Install Dependencies
+
+```shell
+cd ${KYUUBI_SOURCE_CODE}/kyuubi-server/web-ui
+npm install
+```
+
+## Develop
+
+Notice:
+
+Before you start the Web UI project, please make sure the Kyuubi server has been started.
+
+Kyuubi Web UI will proxy the requests to Kyuubi server, with the default endpoint path to`http://localhost:10099`. Modify `VITE_APP_DEV_WEB_URL` in `.env.development` for customizing targeted endpoint path.
+
+#### Why proxy to http://localhost:10099

Review Comment:
   no H4



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184581824


##########
docs/contributing/code/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI

Review Comment:
   Move all these to buiding.md



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184583856


##########
docs/contributing/code/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]
+2. Install [nodejs](https://nodejs.org/en/)[Recommend 18.x.x]
+
+## Install Dependencies
+
+```shell
+cd ${KYUUBI_SOURCE_CODE}/kyuubi-server/web-ui
+npm install
+```
+
+## Develop
+
+Notice:
+
+Before you start the Web UI project, please make sure the Kyuubi server has been started.
+
+Kyuubi Web UI will proxy the requests to Kyuubi server, with the default endpoint path to`http://localhost:10099`. Modify `VITE_APP_DEV_WEB_URL` in `.env.development` for customizing targeted endpoint path.
+
+#### Why proxy to http://localhost:10099
+
+Current Kyuubi server binds on `http://0.0.0.0:10099` in case you are running Kyuubi server in macOS or Windows(If in Linux, you should config Kyuubi server `kyuubi.frontend.rest.bind.host=0.0.0.0`, or change `VITE_APP_DEV_WEB_URL` in `.env.development`).
+
+```shell
+npm run dev
+```
+
+You can access Kyuubi Web UI at `http://localhost:9090/ui`
+
+### Build Project
+
+```shell
+npm run build
+```
+
+### Code Style
+
+Usually after you modify the code, you need to perform code formatting operations to ensure that the code in the project is the same style.

Review Comment:
   which code style that we have applied



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184579099


##########
docs/deployment/web_ui.md:
##########
@@ -0,0 +1,30 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI
+
+## Build Kyuubi Binary with Web UI
+
+See [Build with Web UI](../develop_tools/building.md#build-with-web-ui)
+

Review Comment:
   ```suggestion
   ```



##########
docs/deployment/web_ui.md:
##########
@@ -0,0 +1,30 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI

Review Comment:
   ```suggestion
   # Web UI
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] bowenliang123 commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "bowenliang123 (via GitHub)" <gi...@apache.org>.
bowenliang123 commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1177475186


##########
docs/develop_tools/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Develop Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]
+2. Install [nodejs](https://nodejs.org/en/)[Recommend 16.x.x]
+
+## Install Dependencies
+
+```shell
+cd ${KYUUBI_SOURCE_CODE}/kyuubi-server/web-ui
+npm install
+```
+
+## Develop
+
+Notice:
+
+Before you start the Web UI project, please make sure the Kyuubi server has been started.
+
+Kyuubi Web UI will proxy the requests to Kyuubi server,  with the default endpoint path to`http://localhost:10099`. Modify `VITE_APP_DEV_WEB_URL` in `.env.development` for customizing targeted endpoint path.
+
+#### Why proxy to http://localhost:10099
+
+Current kyuubi server binds on `http://0.0.0.0:10099` in case you are running kyuubi server in MacOS or Windows(If in linux, you should config kyuubi server `kyuubi.frontend.rest.bind.host=0.0.0.0`, or change `VITE_APP_DEV_WEB_URL` in `.env.development`).
+
+```shell
+npm run dev
+```
+
+You can access Kyuubi Web UI with `http://localhost:9090/ui`
+
+### Build Project
+
+```shell
+npm run build
+```
+
+### Code Format
+
+Usually after you modify the code, you need to perform code formatting operations to ensure that the code in the project is the same style.
+
+```shell
+npm run prettier
+```
+
+## Recommend

Review Comment:
   ```suggestion
   ## Recommendation
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1179866256


##########
docs/deployment/web_ui.md:
##########
@@ -0,0 +1,42 @@
+<!--
+- 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.
+-->
+
+# Deploy Kyuubi Web UI

Review Comment:
   ```suggestion
   # Web UI
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] zwangsheng commented on pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "zwangsheng (via GitHub)" <gi...@apache.org>.
zwangsheng commented on PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#issuecomment-1522840918

   ![截屏2023-04-26 下午2 08 48](https://user-images.githubusercontent.com/52876270/234484807-7c8917ae-c056-427a-a7d7-a7be0f4b8a2d.png)
   ![截屏2023-04-26 下午2 09 02](https://user-images.githubusercontent.com/52876270/234484814-3249caa3-1abc-4d12-a9ae-d19ed28ef791.png)
   


-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] pan3793 commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "pan3793 (via GitHub)" <gi...@apache.org>.
pan3793 commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1177430702


##########
docs/develop_tools/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Develop Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]
+2. Install [nodejs](https://nodejs.org/en/)[Recommend 16.x.x]
+
+## Install Dependencies
+
+```shell
+cd ${KYUUBI_SOURCE_CODE}/kyuubi-server/web-ui
+npm install
+```
+
+## Develop
+
+Notice:
+
+Before you start the Web UI project, please make sure the Kyuubi server has been started.
+
+Kyuubi Web UI will proxy the requests to Kyuubi server,  with the default endpoint path to`http://localhost:10099`. Modify `VITE_APP_DEV_WEB_URL` in `.env.development` for customizing targeted endpoint path.

Review Comment:
   nit: an extra space before "with"



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184580079


##########
docs/deployment/web_ui.md:
##########
@@ -0,0 +1,30 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI
+
+## Build Kyuubi Binary with Web UI
+
+See [Build with Web UI](../develop_tools/building.md#build-with-web-ui)
+
+## Run Kyuubi Server with Web UI
+
+```shell
+${KYUUBI_BINARY}/bin/kyuubi start

Review Comment:
   ```suggestion
   $ ${KYUUBI_HOME}/bin/kyuubi start
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] zwangsheng commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "zwangsheng (via GitHub)" <gi...@apache.org>.
zwangsheng commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184582998


##########
docs/contributing/code/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]
+2. Install [nodejs](https://nodejs.org/en/)[Recommend 18.x.x]
+
+## Install Dependencies
+
+```shell
+cd ${KYUUBI_SOURCE_CODE}/kyuubi-server/web-ui
+npm install
+```
+
+## Develop
+
+Notice:
+
+Before you start the Web UI project, please make sure the Kyuubi server has been started.
+
+Kyuubi Web UI will proxy the requests to Kyuubi server, with the default endpoint path to`http://localhost:10099`. Modify `VITE_APP_DEV_WEB_URL` in `.env.development` for customizing targeted endpoint path.
+
+#### Why proxy to http://localhost:10099
+
+Current Kyuubi server binds on `http://0.0.0.0:10099` in case you are running Kyuubi server in macOS or Windows(If in Linux, you should config Kyuubi server `kyuubi.frontend.rest.bind.host=0.0.0.0`, or change `VITE_APP_DEV_WEB_URL` in `.env.development`).
+
+```shell
+npm run dev
+```
+
+You can access Kyuubi Web UI at `http://localhost:9090/ui`
+
+### Build Project
+
+```shell
+npm run build
+```
+
+### Code Style
+
+Usually after you modify the code, you need to perform code formatting operations to ensure that the code in the project is the same style.

Review Comment:
   For front-end code style, there are many style type, we recommend dev formate after modify.



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] zwangsheng commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "zwangsheng (via GitHub)" <gi...@apache.org>.
zwangsheng commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184595621


##########
docs/contributing/code/building.md:
##########
@@ -91,3 +91,10 @@ The `fast` profile helps to significantly reduce build time, which is useful for
 build/mvn clean package -Pfast
 ```
 
+## Build with Web UI
+
+The Kyuubi Release 1.7.1 and earlier does not include the Web UI module, you should build Kyuubi Binary from master branch.

Review Comment:
   1.8.0



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184577791


##########
docs/contributing/code/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]

Review Comment:
   ```suggestion
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184577479


##########
docs/contributing/code/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI

Review Comment:
   ```suggestion
   # Web UI
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184577116


##########
docs/contributing/code/building.md:
##########
@@ -91,3 +91,12 @@ The `fast` profile helps to significantly reduce build time, which is useful for
 build/mvn clean package -Pfast
 ```
 
+## Build with Web UI
+
+The Kyuubi Release 1.7.1 and earlier does not include the Web UI module, you should build Kyuubi Binary from master branch.
+
+```shell
+${KYUUBI_SOURCE_CODE}/build/dist [other args your want] --web-ui

Review Comment:
   ```suggestion
   ${KYUUBI_SOURCE_CODE}/build/dist --web-ui
   ```



##########
docs/contributing/code/building.md:
##########
@@ -91,3 +91,12 @@ The `fast` profile helps to significantly reduce build time, which is useful for
 build/mvn clean package -Pfast
 ```
 
+## Build with Web UI
+
+The Kyuubi Release 1.7.1 and earlier does not include the Web UI module, you should build Kyuubi Binary from master branch.
+
+```shell
+${KYUUBI_SOURCE_CODE}/build/dist [other args your want] --web-ui
+```
+
+See more details in `${KYUUBI_HOME}/build/dist` script.

Review Comment:
   ```suggestion
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184576700


##########
docs/contributing/code/building.md:
##########
@@ -91,3 +91,12 @@ The `fast` profile helps to significantly reduce build time, which is useful for
 build/mvn clean package -Pfast
 ```
 
+## Build with Web UI

Review Comment:
   ```suggestion
   ## Building With Web UI
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1179864819


##########
docs/deployment/web_ui.md:
##########
@@ -0,0 +1,42 @@
+<!--
+- 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.
+-->
+
+# Deploy Kyuubi Web UI
+
+> Notice. The Kyuubi Web UI still in development, changes to code, functionality, and interface may occur at any time.

Review Comment:
   a notice here is not necessary



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] pan3793 commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "pan3793 (via GitHub)" <gi...@apache.org>.
pan3793 commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1177433383


##########
docs/develop_tools/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Develop Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]
+2. Install [nodejs](https://nodejs.org/en/)[Recommend 16.x.x]
+
+## Install Dependencies
+
+```shell
+cd ${KYUUBI_SOURCE_CODE}/kyuubi-server/web-ui
+npm install
+```
+
+## Develop
+
+Notice:
+
+Before you start the Web UI project, please make sure the Kyuubi server has been started.
+
+Kyuubi Web UI will proxy the requests to Kyuubi server,  with the default endpoint path to`http://localhost:10099`. Modify `VITE_APP_DEV_WEB_URL` in `.env.development` for customizing targeted endpoint path.
+
+#### Why proxy to http://localhost:10099
+
+Current kyuubi server binds on `http://0.0.0.0:10099` in case you are running kyuubi server in MacOS or Windows(If in linux, you should config kyuubi server `kyuubi.frontend.rest.bind.host=0.0.0.0`, or change `VITE_APP_DEV_WEB_URL` in `.env.development`).
+
+```shell
+npm run dev
+```
+
+You can access Kyuubi Web UI with `http://localhost:9090/ui`

Review Comment:
   with => at



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] bowenliang123 commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "bowenliang123 (via GitHub)" <gi...@apache.org>.
bowenliang123 commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1177475512


##########
docs/develop_tools/web_ui.md:
##########
@@ -0,0 +1,84 @@
+<!--
+- 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.
+-->
+
+# Develop Kyuubi Web UI
+
+Requirement:
+
+1. Fork Kyuubi source code[version >= 1.8.0]
+2. Install [nodejs](https://nodejs.org/en/)[Recommend 16.x.x]
+
+## Install Dependencies
+
+```shell
+cd ${KYUUBI_SOURCE_CODE}/kyuubi-server/web-ui
+npm install
+```
+
+## Develop
+
+Notice:
+
+Before you start the Web UI project, please make sure the Kyuubi server has been started.
+
+Kyuubi Web UI will proxy the requests to Kyuubi server,  with the default endpoint path to`http://localhost:10099`. Modify `VITE_APP_DEV_WEB_URL` in `.env.development` for customizing targeted endpoint path.
+
+#### Why proxy to http://localhost:10099
+
+Current kyuubi server binds on `http://0.0.0.0:10099` in case you are running kyuubi server in MacOS or Windows(If in linux, you should config kyuubi server `kyuubi.frontend.rest.bind.host=0.0.0.0`, or change `VITE_APP_DEV_WEB_URL` in `.env.development`).
+
+```shell
+npm run dev
+```
+
+You can access Kyuubi Web UI with `http://localhost:9090/ui`
+
+### Build Project
+
+```shell
+npm run build
+```
+
+### Code Format

Review Comment:
   ```suggestion
   ### Code Style
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] codecov-commenter commented on pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#issuecomment-1522945416

   ## [Codecov](https://codecov.io/gh/apache/kyuubi/pull/4775?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) Report
   > Merging [#4775](https://codecov.io/gh/apache/kyuubi/pull/4775?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (369cc7c) into [master](https://codecov.io/gh/apache/kyuubi/commit/0b72a6151cf8441e51592a5eb7c4b7816898e41a?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (0b72a61) will **decrease** coverage by `0.06%`.
   > The diff coverage is `n/a`.
   
   ```diff
   @@             Coverage Diff              @@
   ##             master    #4775      +/-   ##
   ============================================
   - Coverage     57.98%   57.93%   -0.06%     
     Complexity       13       13              
   ============================================
     Files           581      581              
     Lines         32423    32423              
     Branches       4309     4309              
   ============================================
   - Hits          18801    18784      -17     
   - Misses        11822    11832      +10     
   - Partials       1800     1807       +7     
   ```
   
   
   [see 11 files with indirect coverage changes](https://codecov.io/gh/apache/kyuubi/pull/4775/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
   
   :mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
   


-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#issuecomment-1523010227

   https://github.com/apache/kyuubi/pull/4768/files#diff-d53927957e727c585d886364d9a70c69723d47169185468c7eb3b5e5cf178a80 Please try these documentation style guidelines to polish to content and representation


-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] yaooqinn commented on a diff in pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#discussion_r1184579756


##########
docs/deployment/web_ui.md:
##########
@@ -0,0 +1,30 @@
+<!--
+- 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.
+-->
+
+# Kyuubi Web UI
+
+## Build Kyuubi Binary with Web UI
+
+See [Build with Web UI](../develop_tools/building.md#build-with-web-ui)
+
+## Run Kyuubi Server with Web UI
+
+```shell
+${KYUUBI_BINARY}/bin/kyuubi start
+```
+
+Access the experimental Kyuubi Web at `http://0.0.0.0:10099/ui/`

Review Comment:
   ```suggestion
   Access the Kyuubi Web UI at `http://0.0.0.0:10099/ui/`
   ```



-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [kyuubi] bowenliang123 commented on pull request #4775: [KYUUBI #4761][DOC] Deploy & Develop Kyuubi Web UI

Posted by "bowenliang123 (via GitHub)" <gi...@apache.org>.
bowenliang123 commented on PR #4775:
URL: https://github.com/apache/kyuubi/pull/4775#issuecomment-1694397169

   This passage appears to be more colloquial and falls short of the level of formal text. It still requires further refinement to avoid redundant content and colloquial expressions.


-- 
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: notifications-unsubscribe@kyuubi.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org