You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hugegraph.apache.org by ji...@apache.org on 2026/08/30 10:58:29 UTC
(hugegraph-toolchain) 14/24: docs(hubble): add English product showcase
This is an automated email from the ASF dual-hosted git repository.
imbajin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hugegraph-toolchain.git
commit 0f4e9f25a9863d13fde2008971e99301422e9061
Author: dark <ji...@apache.org>
AuthorDate: Sat Aug 29 23:06:30 2026 +0800
docs(hubble): add English product showcase
- add live English screenshots for core workflows
- organize assets under one showcase directory
- add root and Hubble product tours
---
README.md | 13 ++---
hugegraph-hubble/README.md | 58 ++++++++++++++-------
.../docs/images/showcase/async-tasks.jpg | Bin 0 -> 63998 bytes
.../docs/images/showcase/gql-traversal.jpg | Bin 0 -> 76776 bytes
.../docs/images/showcase/home-workbench.jpg | Bin 0 -> 88896 bytes
.../docs/images/showcase/schema-templates.jpg | Bin 0 -> 75969 bytes
6 files changed, 46 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
index bdc68a7cd..602be9ce2 100644
--- a/README.md
+++ b/README.md
@@ -12,12 +12,13 @@
A comprehensive suite of client SDKs, data tools, and management utilities for [Apache HugeGraph](https://github.com/apache/hugegraph) graph database. Build applications, load data, and manage graphs with production-ready tools.
-Hubble's primary authentication and connection design targets HugeGraph
-`1.8/master`: PD discovery supplies the server address, anonymous mode uses a
-real unauthenticated client, and account/GraphSpace permissions are reduced to
-four readable presets. A thin adapter keeps 1.7 usable and limits 1.5 to its
-standalone core graph workflow; version checks are centralized rather than
-spread across UI pages.
+Hubble's primary authentication and connection design targets HugeGraph `1.8/master`: PD discovery supplies the server address, anonymous mode uses a real unauthenticated client, and account/GraphSpace permissions are reduced to four readable presets. A thin adapter keeps 1.7 usable and limits 1.5 to its standalone core graph workflow; version checks are centralized rather than spread across UI pages.
+
+### Hubble Workbench
+
+Hubble brings graph exploration, schema preparation, asynchronous analysis, and distributed cluster operations into one workspace.
+
+
**Quick Navigation**: [Architecture](#architecture-overview) | [Quick Start](#quick-start) | [Modules](#module-overview) | [Build](#build--development) | [Docker](#docker) | [Related Projects](#related-projects)
diff --git a/hugegraph-hubble/README.md b/hugegraph-hubble/README.md
index fde297990..0b2b94e7d 100644
--- a/hugegraph-hubble/README.md
+++ b/hugegraph-hubble/README.md
@@ -7,27 +7,47 @@
hugegraph-hubble is a graph management and analysis platform that provides features:
graph data load, schema management, graph relationship analysis, and graphical display.
+## Product Tour
+
+### Graph Data Workbench
+
+Start from one workspace for graph discovery, import, query, account management, and cluster operations.
+
+
+
+### GQL Traversal
+
+Run Gremlin queries and inspect their graph, table, or JSON results without leaving the workbench.
+
+
+
+### Schema Templates
+
+Prepare reusable schemas before configuring data sources and import tasks.
+
+
+
+### Asynchronous Tasks
+
+Track asynchronous queries and algorithms, then expand compact results inline.
+
+
+
## Authentication, connections, and compatibility
-Hubble uses one capability-driven connection boundary for `1.8/master`.
-Authentication mode is detected from the connected HugeGraph Server; Hubble
-does not maintain a separate authentication switch. Account and permission
-entry points are hidden when Server allows anonymous access. Connection
-switching always goes through the backend resolver. In PD mode, a valid server
-address returned by discovery is sufficient; a manually configured server URL
-is not required.
-
-The UI presents four stable permission meanings: super administrator, GraphSpace
-read-only, GraphSpace read-write, and GraphSpace administrator. The last one
-means member management plus read/write within that GraphSpace; low-level
-`role`, `target`, `access`, and `belong` fields are not exposed.
-
-The compatibility boundary is deliberately small. Server 1.7 uses a thin
-legacy-response fallback. Server 1.5 standalone is limited to core graph,
-schema, data, and Gremlin operations; GraphSpace management is reported as
-unsupported. Version checks stay in the client adapter/resolver rather than
-being scattered through controllers or pages. See
-[`AGENTS.md`](AGENTS.md) for the support matrix and verification rules.
+Hubble uses one capability-driven connection boundary for `1.8/master`. Authentication mode is detected from the connected HugeGraph Server; Hubble does not maintain a separate authentication switch. Account and permission entry points are hidden when Server allows anonymous access. Connection switching always goes through the backend resolver. In PD mode, a valid server address returned by discovery is sufficient; a manually configured server URL is not required.
+
+The UI presents four stable permission meanings: super administrator, GraphSpace read-only, GraphSpace read-write, and GraphSpace administrator. The last one means member management plus read/write within that GraphSpace; low-level `role`, `target`, `access`, and `belong` fields are not exposed.
+
+The compatibility boundary is deliberately small:
+
+| HugeGraph Server / PD | Deployment | Hubble compatibility | Scope and limitations |
+|---|---|---|---|
+| Server 1.5.x | Standalone, normally without authentication | Minimum compatibility | Basic graph, schema, data, and Gremlin workflows only. GraphSpace, account permissions, PD/Store topology, cluster operations, and newer algorithms are unavailable. |
+| Server 1.7.x with matching PD/Store 1.7.x | Standalone or distributed | Minimum compatibility through legacy adapters | Core management and query workflows remain usable, but legacy REST/Gremlin authentication, permission semantics, metrics, and algorithm capabilities may provide a reduced experience. |
+| Server, PD, and Store 1.8.x or later | Distributed deployment recommended | Full and recommended experience | Current GraphSpace, account permission presets, cluster operations, async tasks, and algorithm capability handling are designed and validated against this generation. |
+
+Use matching Server, PD, and Store minor versions in a distributed cluster. **Server/PD 1.8 or later is strongly recommended for the best Hubble experience.** Support for 1.5 and 1.7 is intentionally limited to minimum usability and does not imply feature parity with the current release. Version checks stay in the client adapter/resolver rather than being scattered through controllers or pages. See [`AGENTS.md`](AGENTS.md) for verification rules.
## Local development feedback loop
diff --git a/hugegraph-hubble/docs/images/showcase/async-tasks.jpg b/hugegraph-hubble/docs/images/showcase/async-tasks.jpg
new file mode 100644
index 000000000..a01bbb65f
Binary files /dev/null and b/hugegraph-hubble/docs/images/showcase/async-tasks.jpg differ
diff --git a/hugegraph-hubble/docs/images/showcase/gql-traversal.jpg b/hugegraph-hubble/docs/images/showcase/gql-traversal.jpg
new file mode 100644
index 000000000..76a9c1477
Binary files /dev/null and b/hugegraph-hubble/docs/images/showcase/gql-traversal.jpg differ
diff --git a/hugegraph-hubble/docs/images/showcase/home-workbench.jpg b/hugegraph-hubble/docs/images/showcase/home-workbench.jpg
new file mode 100644
index 000000000..53cfebfb6
Binary files /dev/null and b/hugegraph-hubble/docs/images/showcase/home-workbench.jpg differ
diff --git a/hugegraph-hubble/docs/images/showcase/schema-templates.jpg b/hugegraph-hubble/docs/images/showcase/schema-templates.jpg
new file mode 100644
index 000000000..d402a2a19
Binary files /dev/null and b/hugegraph-hubble/docs/images/showcase/schema-templates.jpg differ