Commit 655c3fd
authored
BREAKING CHANGE: graduate as TLP & refactor a string of docs (#447)
* docs: AGENTS.md, README.md, contribution.md
Restructure and clarify repository documentation. AGENTS.md was rewritten and condensed into a practical agent/dev guide with development commands, prerequisites (Hugo Extended, Node.js v16+), content/structure overview, CI/CD notes, and troubleshooting tips. README.md was replaced with a bilingual (ZH/EN) homepage including a 3-step quickstart, repo layout, common commands, contributing requirements, contact info, and license. contribution.md was expanded with a PR checklist and clearer contribution steps (fork/branch/PR with screenshots). These changes improve onboarding and contribution workflows for the docs site.
* Update README.md
* server: update docs and configs for HugeGraph 1.7.0
Bump documentation site version and update docs/configs to reflect HugeGraph 1.7.0 changes: update config.toml version to 1.7; add Version Change notices for Auth REST API in CN/EN; revise HugeGraph-Server quickstart (docker images, download/toolchain URLs) and add deprecation warnings for removed legacy backends (MySQL, PostgreSQL, Cassandra, ScyllaDB) in favor of 1.7 backends (RocksDB, HStore, HBase, Memory). Update default rest-server config docs: increase batch.max_* defaults, raise batch.max_write_ratio, set exception.allow_trace true, add log.slow_query_threshold, and add K8s / PD/Meta / Arthas configuration option sections.
* toolchain: add Spark connector and update Hubble/Tools
Add HugeGraph-Spark-Connector quick start docs (English and Chinese). Add a Configuration section to HugeGraph-Hubble docs (server settings and Gremlin query limits) in both languages. Update hugegraph-tools docs (EN/CN) to document new graph commands (graph-create, graph-clone, graph-drop), authentication backup/restore (auth-backup, auth-restore), --thread-num option for relevant commands, and minor heading/usage adjustments.
* AI: Add HugeGraph-AI docs and quickstart updates
Add comprehensive HugeGraph-AI documentation and update quickstart content. New files added (Chinese & English): config-reference.md (full configuration reference), hugegraph-ml.md (HugeGraph-ML overview, algorithms and examples), and rest-api.md (REST API reference including RAG and Text2Gremlin endpoints). Updated pages: _index.md (feature list and v1.5.0 highlights such as Text2Gremlin, multi-model vectors, bilingual prompts, LiteLLM support, enhanced rerankers), hugegraph-llm.md (LLM provider/LiteLLM, reranker and Text2Gremlin usage), and quick_start.md (language switching / bilingual prompt guide). Also tightened environment requirements (Python 3.10+, uv 0.7+, HugeGraph 1.5+) and updated ML algorithm count/details to 21. These changes expand docs for deploying and integrating LLM, Text2Gremlin, ML workflows and REST APIs.
* Revise and expand Computer config docs (CN/EN)
Rewrite and restructure the Computer configuration documentation in both Chinese and English. The changes replace the old flat option tables with organized sections (Basics, Algorithm, Input, Snapshot/Storage, Worker/Master, I/O/Output, Network/Transport, Storage, BSP, Performance, System-managed, K8s Operator, KubeDriver and CRD). Added clear default-value semantics, examples for local and MinIO snapshots, notes about system-managed options (do not modify), and more explanatory text for many options. Also updated related CRD/KubeDriver fields formatting and clarified operator environment variable mapping. Minor related updates applied to the quickstart computing hugegraph-computer page.
* BREAKING CHANGE: update docs links and Chinese content
Change repository links from incubator to apache/hugegraph and apache/hugegraph-doc in config and many docs; update Chinese homepage and docs with refreshed wording (add AI/LLM, features blocks, revised introductions and CTAs); adjust multiple changelog weights and fix numerous internal/repo links and examples to reflect project rename and content improvements.
* Add API descriptions and update quickstart links
Add description frontmatter to many REST API docs (Chinese and English) to provide concise summaries for each API page. Update quickstart index pages (computing, hugegraph‑ai, toolchain) to recommend DeepWiki with direct links and add GitHub access links. Revise CN FAQ backend storage guidance to describe single-node (RocksDB) vs distributed (HStore) deployment, recommend selection by scale, and note deprecation of Cassandra/HBase/MySQL in later versions.
* Update config docs titles and layout
Revise configuration documentation for both CN and EN sites: update page titles and linkTitle fields for config guide and options, enrich the config index pages with Server configuration overview and links (including auth/HTTPS), and move/rename the Computer config page from config/ to quickstart/computing/ with updated title, linkTitle and weight. Also adjust wording about distributed deployment scale (changed from "100GB+" to "< 1000TB") in FAQ and introduction pages for both languages.
* Update config docs: titles and reformat sections
Rename config guide and reference titles (English & Chinese) to "Server Startup Guide" and "Server Complete Configuration Manual"; reorganize config-option pages by converting optional/config blocks (K8s, Arthas, RPC server, HBase, Cassandra/ScyllaDB, MySQL/PostgreSQL) into collapsible <details> sections and group deprecated backends under a "≤ 1.5 Version Config (Legacy)" section. Also adjust index bullets ordering/labels. These changes improve readability and clearly mark legacy backend configs.1 parent fa6ee62 commit 655c3fd
File tree
123 files changed
+4370
-747
lines changed- content
- cn
- docs
- changelog
- clients
- restful-api
- config
- contribution-guidelines
- download
- guides
- introduction
- quickstart
- client
- computing
- hugegraph-ai
- hugegraph
- toolchain
- en
- community
- docs
- changelog
- clients
- restful-api
- config
- contribution-guidelines
- download
- guides
- introduction
- quickstart
- client
- computing
- hugegraph-ai
- hugegraph
- toolchain
- themes/docsy/layouts/partials
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
123 files changed
+4370
-747
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
48 | | - | |
| 48 | + | |
49 | 49 | | |
50 | 50 | | |
51 | 51 | | |
| |||
159 | 159 | | |
160 | 160 | | |
161 | 161 | | |
162 | | - | |
| 162 | + | |
163 | 163 | | |
164 | | - | |
| 164 | + | |
165 | 165 | | |
166 | 166 | | |
167 | 167 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | | - | |
15 | | - | |
16 | 14 | | |
17 | 15 | | |
18 | 16 | | |
19 | 17 | | |
20 | 18 | | |
21 | 19 | | |
22 | 20 | | |
23 | | - | |
24 | | - | |
| 21 | + | |
| 22 | + | |
25 | 23 | | |
26 | 24 | | |
27 | 25 | | |
28 | 26 | | |
29 | 27 | | |
30 | 28 | | |
31 | | - | |
32 | | - | |
| 29 | + | |
| 30 | + | |
33 | 31 | | |
34 | 32 | | |
35 | 33 | | |
| |||
49 | 47 | | |
50 | 48 | | |
51 | 49 | | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
52 | 65 | | |
53 | 66 | | |
54 | 67 | | |
55 | 68 | | |
56 | 69 | | |
57 | | - | |
| 70 | + | |
58 | 71 | | |
59 | 72 | | |
60 | 73 | | |
| |||
63 | 76 | | |
64 | 77 | | |
65 | 78 | | |
66 | | - | |
| 79 | + | |
67 | 80 | | |
68 | 81 | | |
69 | 82 | | |
| |||
84 | 97 | | |
85 | 98 | | |
86 | 99 | | |
87 | | - | |
| 100 | + | |
88 | 101 | | |
89 | 102 | | |
90 | 103 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
0 commit comments