[pull] master from apache:master - #32
Open
pull[bot] wants to merge 21 commits into
Open
Conversation
- add the new option to English and Chinese config examples - document the byte limit and disable value - note that recorded query prefixes may contain literals
This PR moves the Apache HugeGraph documentation site from Docsy to pinned OINK 1.0 It preserves the familiar HugeGraph product story and public URLs while improving how users navigate, search, and compare documentation across languages and supported versions. - pin OINK, Go, Hugo, and GitHub Actions versions - replace Docsy landing and bilingual configuration - add strict production and staging artifact validation - preserve aliases, machine outputs, and license notices
- rewrite major Chinese docs pages for clearer structure and terminology - align Server/REST examples to graphspace-based paths and current defaults - update component guidance across Toolchain, Computer, Vermeer, and HugeGraph-AI - replace project CLA text with ASF ICLA/CCLA contribution instructions - add /.goal-task to .gitignore - keep the restored 1.7 introduction route canonical - retain the legacy readme fallback for 1.5 - preserve shared historical Loader route handling
Fix the GraphSpace and edge API claims, document Config fields and the hgtransport loggers, and list the exact operations behind each entry point.
Pin Spark 3.2.2 / Scala 2.12.11, correct the delimiter scope, document the username and trust store fallbacks, mark required options, and add PRIMARY_KEY and mixed id strategy examples plus a notes and limitations section, in both en and cn.
Bring the hugegraph-tools pages (en and cn) back in line with the CLI on toolchain master: drop the unregistered --protocol global, add --throw-mode, fix the graph-create/graph-clone, --log, dump and auth directory defaults, add the missing --thread-num option and the 'schema' type, drop --log and --thread-num from the auth commands where they do not exist, document the timeout floors and the schedule-backup, deploy and clear behaviour, and refresh the usage block with the commands and text it was missing. Also correct the graph modes and default url in the backup/restore guide.
Correct the Java client API names that no longer exist (asUUID, T.LABEL, T.ID, getGraphNumberUsed) and document the parts of the client the page never covered: the full set of HugeClient builder options with their defaults, the manager entry points beyond schema/graph/gremlin, property key aggregate and write types, the customize-uuid id strategy, schema label ttl, multi-pair edge links and edge label types, and the GraphSpace default-role and quota methods. Applied to both the en and cn pages.
Add the missing HBase backend configuration page in English and Chinese. It documents the supported HBase version, how to select the backend, all fifteen HbaseOptions keys with their defaults and value ranges grouped as the Options class groups them, the Kerberos settings, the namespace and table layout, the docker/hbase setup for local testing, and the features the backend reports as unsupported.
Correct the loader mapping file and CLI reference against toolchain master: input source defaults and missing keys (has_header, dir_filter, kerberos_config, where, batch_size), the failure and progress file layout, the GRAPH input source rules, and the executor scripts. Adds sections for the flink-cdc loader and the spark-loader argument split, repairs a broken table row on the English page, and bumps the Docker image tags in the quick start examples from 1.5.0 to 1.7.0 so both language pages match the rest of the site.
Rewrote the HugeGraph-Store quickstart to match hugegraph master: the application.yml block now mirrors the shipped template, application-pd.yml and its rocksdb keys are documented, and a full configuration reference lists every key the node reads with its template value and code default. Also documented the -g/-j/-y start flags, the restart script, the PD to Store to Server startup order and the pd.initial-store-list requirement, the Store REST endpoints that actually exist in hg-store-node, the minimal docker-compose-hstore.yml topology, and the image defaults. Fixed the wrong Chinese tar directory name. The PD /v1/stores check now passes basic auth credentials, since PD's REST interceptor covers every path except /v1/health, /actuator/* and /v1/prom/targets/*.
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.
Align the hugegraph-ai overview, HugeGraph-LLM, workflow, REST API and configuration pages with the code on hugegraph-ai main (1.7.0): correct Python and HugeGraph Server ranges, document the uv extras, container images and Helm chart, add CUR_VECTOR_INDEX and HUGEGRAPH_LLM_ENV_PATH, fix the Template Num semantics, and fill in missing request fields, status codes and UI features.
Rebuild the Implemented Models table from src/hugegraph_ml/models/ so it lists every module, its entry class and its paper, including GIN and MLPClassifier. Correct the BGNN row: the bundled example runs regression over tabular node features, not fraud detection. Add sections for the HugeGraph2DGL conversion methods, the dataset importers and the datasets each accepts, the task classes and their entry points, and the runnable example scripts. Record the ML dependency pins from the root constraint-dependencies block, and add troubleshooting entries for the missing node attributes error, the unsupported dataset error, the bgrl_example MLP_Predictor import mismatch and the missing CARE-GNN dataset importer.
Verify install command against packaging metadata, correct the PyHugeClient signature and workspace sync command, document the 1.5.0 server floor and GraphSpace resolution, and add the manager, traverser, task, variable, metrics, auth and error-handling sections the pages were missing.
Add the missing vermeer-python-client quick start page in en and cn. The module was referenced from the HugeGraph-AI index and the introduction page but had no page of its own. Covers requirements, the uv --extra vermeer and standalone install routes, the PyVermeerClient constructor and its session behavior, an end-to-end load task example based on the shipped demo, the graph and tasks API groups with the Vermeer endpoints they call, the response objects, and the exception types.
Rewrote the PD quickstart configuration, startup and verification sections against hugegraph master. Removed the non-existent store.initial-store-count key, added a full application.yml reference with the defaults from PDConfig, added single-node and three-node cluster examples, documented the -g/-j/-y start flags alongside -d, added the cluster startup order relative to Store and Server, and documented that PD REST requires HTTP Basic auth for every path except /v1/health, /actuator/* and /v1/prom/targets/*, so the verification curl commands now pass credentials. Also added the PD REST endpoint list, the port table, the Docker healthcheck and entrypoint behaviour, and the build output paths.
Add config/config-backend-hstore.md in English and Chinese. The hstore distributed backend had no configuration page: how to select it, the two hstore.* options with their defaults, the rest-server and graph keys that only take effect with PD, how the Server routes requests to Stores through PD, and the query features the backend does not support were all undocumented.
Add the missing RocksDB backend configuration page in English and Chinese. It documents how to select the backend, the data and WAL directory layout for the m/g/s stores, all 70 rocksdb.* options with the defaults and ranges from RocksDBOptions, how optimize_mode, bulkload_mode and the bloom filter group are applied, the per column family memory accounting, SST ingestion, the current state of raft mode for this backend, the backend feature flags, the pinned rocksdbjni 8.10.2 version, and the riscv64 libatomic requirement in the start scripts.
Rebuild the config option tables from CoreOptions, AuthOptions, RoleElectionOptions, ServerOptions, RocksDBOptions and HstoreOptions so every key, default and allowed value matches master: drop the keys that no longer exist, add the 60+ that were missing, and correct wrong defaults such as raft.path, raft.rpc_timeout, gremlinserver.max_route and three RocksDB block cache flags. Also refresh the plugin SPI listings, the TinkerPop feature tables, the vertex and edge id length limits, the CUSTOMIZE_UUID id strategy and the edge label multi-link behaviour, and fix broken Gremlin step links. Mark meta.endpoints as declared but unread: no code reads ServerOptions.META_ENDPOINTS, and GraphManager.initMetaManager builds the meta connection from pd.peers instead.
Align the server deploy, config template, Docker cluster, Gremlin Console and IDEA setup pages with hugegraph master. Drop the deprecated task.scheduler_type key, correct the compose file inventory and the env-var reference against docker-entrypoint.sh and the compose files, match the conf/ template snippets key by key, fix the container script mount path and the graphs endpoint, and document the startup script flags, the security-check Java range and the rocksdb-only build.
Diff every REST resource in hugegraph-api against the docs. Document the endpoints that were missing: login/logout/verify, auth projects, the graphspace default-role and schema-template APIs, graph profile, default graph, nickname update and reload, raft group management, algorithm and computer jobs, the adamic-adar, resource-allocation, edge-existence and count traversers, the index label update, the server profile and API listing, the exception trace switch, the IP allowlist and the Arthas agent. Fix wrong response shapes and status codes for graph create and clone, task cancel, manager check/list/grant/role and single-user query, correct the allowed graph read modes and graph modes, the graphspace required fields, the neighbor-rank top default and the personal-rank depth range, add the missing vertex query and task query parameters, and replace the claim that the HTTPS keystore ships in conf. Also drop task.scheduler_type from the graph creation example. The key is no longer a declared config option, setting it is ignored and only logs a deprecation warning, and the scheduler is picked from the backend type. The note keeps one sentence of history for readers on 1.7.0 and earlier.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See Commits and Changes for more details.
Created by
pull[bot] (v2.0.0-alpha.4)
Can you help keep this open source service alive? 💖 Please sponsor : )