Skip to content

doc(toolchain): sync hubble with master - #480

Merged
imbajin merged 1 commit into
apache:masterfrom
bitflicker64:doc-sync/toolchain-hubble
Sep 6, 2026
Merged

doc(toolchain): sync hubble with master#480
imbajin merged 1 commit into
apache:masterfrom
bitflicker64:doc-sync/toolchain-hubble

Conversation

@bitflicker64

Copy link
Copy Markdown
Contributor

Purpose of the PR

Sync the hugegraph-hubble docs (en + cn) with hugegraph-toolchain master (3b385c3d). Both language pages were checked section by section against the code; every row below is traced to a file on master, and the en and cn pages keep an identical heading structure.

All source paths are relative to the apache/hugegraph-toolchain repository at 3b385c3d.

Page What was wrong What changed Source on master
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Security notice said Hubble has no Auth/Login and that it is planned for 1.8.0 Describes the real behaviour: a sign-in page appears when the connected Server has auth enabled, credentials are forwarded to the Server, account pages are hidden under anonymous access, and the plain HTTP listener still needs HTTPS in front hugegraph-hubble/hubble-be/src/main/java/org/apache/hugegraph/controller/auth/LoginController.java:76
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Module list named Graph Management / Graph Analysis / Task Management Replaced with the modules the navigation actually has: Graph Overview, Metadata Modeling, Data Import, Graph Query, Built-in Graph Algorithms, Async Tasks, System and Operations hugegraph-hubble/hubble-fe/src/components/Sidebar/index.ant.js:68
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md No compatibility information Added section 1.1 with the Server/PD/Store support matrix hugegraph-hubble/README.md:44
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md No JDK requirement stated Stated Java 11 for the backend and the image, and that the start script only checks for a java binary on the PATH hugegraph-hubble/hubble-be/pom.xml:35
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Docker note told users to set the Server hostname on the Hubble web page The web page has no host/port field any more; the Server address comes from server.direct_url or PD discovery in conf/hugegraph-hubble.properties hugegraph-hubble/hubble-be/src/main/java/org/apache/hugegraph/options/HubbleOptions.java:282
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md docker run and compose examples could not reach a Server in another container Documented what the image does (rewrites server.host=0.0.0.0, clears dashboard.address, exposes 8088, runs start-hubble.sh -f) and added a mounted properties file to both examples hugegraph-hubble/Dockerfile:47
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Docker images pinned to 1.5.0 Bumped to 1.7.0, matching the binary download section and the rest of the site hugegraph-toolchain/pom.xml:101
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md bin/start-hubble.sh documented with no options Added the -f / --foreground and -d / --debug options, the JVM flags, the PID and log file paths, and the 30 second wait on /about hugegraph-hubble/hubble-dist/assembly/static/bin/start-hubble.sh:58
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md bin/stop-hubble.sh documented as a bare stop Documented the SIGTERM first, SIGKILL after STOP_TIMEOUT (default 30s) behaviour hugegraph-hubble/hubble-dist/assembly/static/bin/stop-hubble.sh:60
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Source build section had no local development guidance Added yarn dev for the frontend and the note that spring-boot:run is not configured for the backend hugegraph-hubble/README.md:52
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Graph creation described graph ID, host name, port, username and password fields The form takes graph name, alias, schema template and sample data; creation is only offered on REST API 0.67 or later hugegraph-hubble/hubble-fe/src/pages/Graph/EditLayer.js:337, hugegraph-client/src/main/java/org/apache/hugegraph/driver/ServerCompatibility.java:32
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md No mention of GraphSpaces Section 4.1 now covers Graph Space Management in PD mode and the single DEFAULT GraphSpace in standalone mode hugegraph-hubble/hubble-fe/src/utils/productMode.js:21, hugegraph-hubble/hubble-fe/src/routes/index.js:95
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Graph list actions were only overview, search, edit and delete Listed the real actions: View Schema with Groovy export, Metadata Config, Clone Graph, Clear Schema and Data, Delete, Set Default, plus the three demo graphs hugegraph-hubble/hubble-fe/src/i18n/resources/en-US/modules/pages.json:225
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Three "Reuse" subsections described a metadata reuse feature Removed; the metadata pages carry no reuse entry and no reuse i18n key remains in the frontend hugegraph-hubble/hubble-fe/src/pages/Meta/ListView.js:29
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Edge type creation did not mention the type field Added Normal / Parent / Sub for edge type hierarchies hugegraph-hubble/hubble-fe/src/i18n/resources/en-US/modules/pages.json:1098
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Metadata section had no Schema Templates Added 4.2.6 covering the per-GraphSpace template library and its example versus user templates hugegraph-hubble/hubble-be/src/main/java/org/apache/hugegraph/controller/space/SchemaTemplateController.java:48
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Data import described "create a task then upload CSV files" Rewrote around Data Sources (FILE, HDFS, Kafka, JDBC) and the four-step task wizard, plus the Run Once / Scheduled / Realtime schedule step hugegraph-hubble/hubble-fe/src/pages/Datasource/config.js:20, hugegraph-hubble/hubble-fe/src/pages/TaskEdit/index.js:325
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Upload format said "CSV only", with no size limits Accepted formats default to csv and txt, with the 1 GB / 10 GB / 12 hour limits hugegraph-hubble/hubble-be/src/main/java/org/apache/hugegraph/options/HubbleOptions.java:180
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Query section covered Gremlin only Added the Cypher tab, the Text2GQL preview tab, immediate versus async execution, and 2D/3D rendering hugegraph-hubble/hubble-fe/src/i18n/resources/en-US/modules/analysis.json:5, hugegraph-hubble/hubble-fe/src/modules/component/GraphRenderModeSwitcher/index.js:33
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Async task types listed only 4 kinds Listed all 8 kinds and added the 5 second auto refresh and task cancellation hugegraph-hubble/hubble-fe/src/utils/constants.js:138, hugegraph-hubble/hubble-fe/src/modules/asyncTasks/Home/index.js:119
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Said "There is no visual OLAP algorithm execution on Hubble" Replaced with the real Built-in Graph Algorithms page as new section 4.6, covering the OLTP and OLAP forms and the Computer requirement hugegraph-hubble/hubble-fe/src/modules/algorithm/algorithmsForm/OltpHome/index.js:32, hugegraph-hubble/hubble-fe/src/modules/algorithm/algorithmsForm/OlapHome/index.js:34
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md No sign-in or account documentation Added section 4.7 for the login page, the login backoff and the four GraphSpace permission presets hugegraph-hubble/hubble-be/src/main/resources/application.properties:31, hugegraph-hubble/hubble-fe/src/i18n/resources/en-US/modules/pages.json:403
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md No cluster operations documentation Added section 4.8 for Cluster Overview, Node details and the optional external dashboard hugegraph-hubble/hubble-fe/src/routes/index.js:210, hugegraph-hubble/hubble-be/src/main/java/org/apache/hugegraph/controller/op/DashboardController.java:49
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Config table used hubble.host / hubble.port with default 0.0.0.0 Corrected to server.host (default localhost) and server.port (default 8088), and added the protocol and truststore keys hugegraph-hubble/hubble-be/src/main/java/org/apache/hugegraph/options/HubbleOptions.java:60, hugegraph-hubble/hubble-be/src/main/java/org/apache/hugegraph/config/TomcatServletConfig.java:45
content/{en,cn}/docs/quickstart/toolchain/hugegraph-hubble.md Config section covered only server, PD and Gremlin limits Added cluster, client.request_timeout, client.url_cache_max_entries, execute-history.show_limit, the upload_file.* keys, and the operations.* and dashboard.address keys with the Store allowlist warning hugegraph-hubble/hubble-dist/assembly/static/conf/hugegraph-hubble.properties:26, hugegraph-hubble/hubble-be/src/main/java/org/apache/hugegraph/options/HubbleOptions.java:371

Note: graph_connection.ip_white_list and graph_connection.port_white_list are still declared in HubbleOptions but are not read anywhere in hubble-be/src/main, and they are not present in the packaged conf/hugegraph-hubble.properties, so they were left out of the configuration tables.

Update the Hubble quick start pages to match hugegraph-toolchain master:
the sign-in flow driven by the Server auth mode, the current navigation
modules, GraphSpaces, schema templates, data sources and the four-step
import task, the built-in graph algorithm and cluster operations pages,
the real start and stop script flags, and the correct configuration keys
and defaults. Drops the metadata reuse sections, which the interface no
longer offers, and bumps the Docker examples to 1.7.0.

@imbajin imbajin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

中文部分与源码保持一致且表述清晰,评分 9.2/10,按规则可直接合并。

@imbajin
imbajin merged commit 506c565 into apache:master Sep 6, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants