Skip to content

Commit

Permalink
Merge pull request #2 from liukaiming-alipay/update_zh_doc
Browse files Browse the repository at this point in the history
feat: update zh doc(4.5.0/4.3.2/4.3.1)
  • Loading branch information
zhongyunWan authored Oct 24, 2024
2 parents b380ee2 + d6f7ecf commit 188d8c4
Show file tree
Hide file tree
Showing 5 changed files with 571 additions and 9 deletions.
5 changes: 3 additions & 2 deletions docusaurus/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,6 @@
},
"engines": {
"node": ">=18.0"
}
}
},
"repository": "https://github.com/liukaiming-alipay/tugraph-db.git"
}
6 changes: 5 additions & 1 deletion docusaurus/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
}

/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
[data-theme="dark"] {
--ifm-color-primary: #25c2a0;
--ifm-color-primary-dark: #21af90;
--ifm-color-primary-darker: #1fa588;
Expand All @@ -33,3 +33,7 @@
.navbar {
display: none;
}

.sidebarViewport_node_modules-\@docusaurus-theme-classic-lib-theme-DocRoot-Layout-Sidebar-styles-module {
overflow-y: auto;
}
189 changes: 187 additions & 2 deletions docusaurus/versions_sidebars/version-4.3.1_zh.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";

/**
* Creating a sidebar enables you to:
Expand All @@ -12,7 +12,192 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
*/
const sidebars: SidebarsConfig = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
// tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],

// But you can create a sidebar manually
tutorialSidebar: [
"guide",
{
type: "category",
label: "Tugraph 入门",
items: [
"introduction/what-is-graph",
"introduction/what-is-gdbms",
"introduction/what-is-tugraph",
"introduction/schema",
{
type: "category",
label: "产品特点",
items: [
"introduction/characteristics/performance-oriented",
"introduction/characteristics/multi-level-Interfaces",
"introduction/characteristics/htap",
],
},
"introduction/architecture",
"introduction/functionality",
"introduction/scenarios",
"introduction/glossary",
],
},
{
type: "category",
label: "快速上手",
items: [
"quick-start/preparation",
{
type: "category",
label: "demo 示例",
items: [
"quick-start/demo/movie",
"quick-start/demo/wandering-earth",
"quick-start/demo/the-three-body",
"quick-start/demo/three-kingdoms",
"quick-start/demo/round-the-world",
],
},
],
},
{
type: "category",
label: "可视化操作指南",
items: [
"user-guide/tugraph-browser",
"user-guide/tugraph-browser-legacy",
],
},
"development_guide",
{
type: "category",
label: "安装和运行",
items: [
"installation&running/environment",
"installation&running/environment-mode",
"installation&running/docker-deployment",
"installation&running/local-package-deployment",
"installation&running/cloud-deployment",
"installation&running/compile",
"installation&running/tugraph-running",
"installation&running/high-availability-mode",
],
},
{
type: "category",
label: "实用工具",
items: [
"utility-tools/data-import",
"utility-tools/data-export",
"utility-tools/backup-and-restore",
"utility-tools/data-warmup",
"utility-tools/ha-cluster-management",
"utility-tools/tugraph-cli",
"utility-tools/tugraph-datax",
"utility-tools/tugraph-explorer",
"utility-tools/restful",
],
},
{
type: "category",
label: "客户端工具",
items: [
"client-tools/python-client",
"client-tools/cpp-client",
"client-tools/java-client",
"client-tools/tugraph-ogm",
"client-tools/bolt-client",
"client-tools/bolt-console-client",
"client-tools/restful-api",
"client-tools/rpc-api",
"client-tools/restful-api-legacy",
],
},
{
type: "category",
label: "查询语言",
items: ["query/cypher", "query/gql"],
},
{
type: "category",
label: "存储过程和分析接口",
items: [
{
type: "category",
label: "存储过程",
link: {
type: "doc",
id: "olap&procedure/procedure/procedure",
},
items: [
"olap&procedure/procedure/traversal",
// 'olap&procedure/procedure/C++-procedure',
// 'olap&procedure/procedure/Python-procedure',
"olap&procedure/procedure/Rust-procedure",
],
},
{
type: "category",
label: "分析接口",
items: [
"olap&procedure/olap/tutorial",
"olap&procedure/olap/olap-base-api",
"olap&procedure/olap/olap-on-db-api",
"olap&procedure/olap/olap-on-disk-api",
"olap&procedure/olap/python-api",
"olap&procedure/olap/algorithms",
],
},
{
type: "category",
label: "图学习",
items: [
"olap&procedure/learn/tutorial",
"olap&procedure/learn/sampling_api",
"olap&procedure/learn/training",
"olap&procedure/learn/heterogeneous_graph",
],
},
],
},
{
type: "category",
label: "运维和权限管理",
items: [
"permission/privilege",
"permission/token",
"permission/reset_admin_password",
"permission/monitoring",
"permission/log",
],
},
{
type: "category",
label: "测试与质量保障",
items: ["quality/unit-testing", "quality/integration-testing"],
},
{
type: "category",
label: "贡献者文档",
items: [
"contributor-manual/contributing",
"contributor-manual/community-roles",
"contributor-manual/individual-cla",
"contributor-manual/corporate-cla",
"contributor-manual/roadmap",
],
},
{
type: "category",
label: "最佳实践",
items: [
"best-practices/rdbms-to-tugraph",
"best-practices/learn_practices",
"best-practices/data_migration",
"best-practices/selection",
],
},
"faq",
"contacts",
],
};

export default sidebars;
Loading

0 comments on commit 188d8c4

Please sign in to comment.