This is an automated email from the ASF dual-hosted git repository. liuxiaocs pushed a commit to branch docusaurus in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
commit a3ac469b22f4983ef352d1347aee16b0c300aee7 Author: liuxiao <[email protected]> AuthorDate: Wed Apr 17 00:54:21 2024 +0800 fix: build link error --- .github/workflows/ci.yml | 4 ++-- .github/workflows/deploy.yml | 4 ++-- ...024-02-04-demo-blog-post.mdx => 2024-02-04-release-1.2.0.mdx} | 4 ++-- ...4-10-demo-blog-post.mdx => 2024-04-10-hugegraph-ai-intro.mdx} | 2 +- blog/authors.yml | 2 +- docs/api/_category_.json | 4 ---- docs/clients/_category_.json | 4 ++++ docs/{api => clients}/gremlin-console.md | 0 docs/{api/hugegraph-client.md => clients/java-client.md} | 4 ++-- docs/{api => clients}/restful-api/_category_.json | 0 docs/{api => clients}/restful-api/auth.md | 2 +- docs/{api => clients}/restful-api/cypher.md | 0 docs/{api => clients}/restful-api/edge.md | 0 docs/{api => clients}/restful-api/edgelabel.md | 2 +- docs/{api => clients}/restful-api/graphs.md | 0 docs/{api => clients}/restful-api/gremlin.md | 4 ++-- docs/clients/restful-api/index.md | 9 +++++++++ docs/{api => clients}/restful-api/indexlabel.md | 2 +- docs/{api => clients}/restful-api/metrics.md | 0 docs/{api => clients}/restful-api/other.md | 0 docs/{api => clients}/restful-api/propertykey.md | 0 docs/{api => clients}/restful-api/rank.md | 0 docs/{api => clients}/restful-api/rebuild.md | 6 +++--- docs/{api => clients}/restful-api/schema.md | 0 docs/{api => clients}/restful-api/task.md | 2 +- docs/{api => clients}/restful-api/traverser.md | 0 docs/{api => clients}/restful-api/variable.md | 0 docs/{api => clients}/restful-api/vertex.md | 0 docs/{api => clients}/restful-api/vertexlabel.md | 2 +- docs/config/config-authentication.md | 2 +- docs/config/config-guide.md | 2 +- docs/contribution-guidelines/contribute.md | 2 +- docs/language/hugegraph-example.md | 2 +- docs/quickstart/hugegraph-client.md | 4 ++-- docs/quickstart/hugegraph-hubble.md | 4 ++-- docs/quickstart/hugegraph-loader.md | 4 ++-- docs/quickstart/hugegraph-server.md | 4 ++-- docs/quickstart/index.md | 9 +++++++++ package.json | 2 +- 39 files changed, 55 insertions(+), 37 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d5e35a98..17db057f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,9 +18,9 @@ name: CI on: pull_request: - branches: [ main ] + branches: [ master ] push: - branches: [ main ] + branches: [ master ] # Concurrency strategy: # github.workflow: distinguish this workflow from others diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index d4756b31..0e304f39 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -19,7 +19,7 @@ name: Deploy on: push: - branches: [ main ] + branches: [ master ] pull_request: jobs: @@ -32,7 +32,7 @@ jobs: node-version: 18.x - uses: pnpm/action-setup@v2 with: - version: 8 + version: 9 - run: pnpm install - run: pnpm run build - run: cp .asf.yaml build/.asf.yaml diff --git a/blog/2024-02-04-demo-blog-post.mdx b/blog/2024-02-04-release-1.2.0.mdx similarity index 90% rename from blog/2024-02-04-demo-blog-post.mdx rename to blog/2024-02-04-release-1.2.0.mdx index f7d2e579..2cf8180e 100644 --- a/blog/2024-02-04-demo-blog-post.mdx +++ b/blog/2024-02-04-release-1.2.0.mdx @@ -1,6 +1,6 @@ --- -slug: release 1.2 -title: Release 1.2 +slug: Release 1.2.0 +title: Release 1.2.0 authors: [imbajin] tags: [apache] --- diff --git a/blog/2024-04-10-demo-blog-post.mdx b/blog/2024-04-10-hugegraph-ai-intro.mdx similarity index 95% rename from blog/2024-04-10-demo-blog-post.mdx rename to blog/2024-04-10-hugegraph-ai-intro.mdx index f447eb16..f7fa6002 100644 --- a/blog/2024-04-10-demo-blog-post.mdx +++ b/blog/2024-04-10-hugegraph-ai-intro.mdx @@ -2,7 +2,7 @@ slug: hugegraph-ai title: HugeGraph AI Post authors: [simon] -tags: [apache] +tags: [ai, hugegraph] --- Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/). diff --git a/blog/authors.yml b/blog/authors.yml index b84e495e..f67ed03b 100644 --- a/blog/authors.yml +++ b/blog/authors.yml @@ -23,7 +23,7 @@ imbajin: simon: name: simon824 - title: Apache Committer + title: Apache HugeGraph PPMC url: https://github.com/simon824 image_url: https://github.com/simon824.png diff --git a/docs/api/_category_.json b/docs/api/_category_.json deleted file mode 100644 index e192ce04..00000000 --- a/docs/api/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "API", - "position": 4 -} \ No newline at end of file diff --git a/docs/clients/_category_.json b/docs/clients/_category_.json new file mode 100644 index 00000000..40d555b4 --- /dev/null +++ b/docs/clients/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Clients", + "position": 4 +} \ No newline at end of file diff --git a/docs/api/gremlin-console.md b/docs/clients/gremlin-console.md similarity index 100% rename from docs/api/gremlin-console.md rename to docs/clients/gremlin-console.md diff --git a/docs/api/hugegraph-client.md b/docs/clients/java-client.md similarity index 98% rename from docs/api/hugegraph-client.md rename to docs/clients/java-client.md index 7e646453..261f57eb 100644 --- a/docs/api/hugegraph-client.md +++ b/docs/clients/java-client.md @@ -9,9 +9,9 @@ The code in this document is written in `java`, but its style is very similar to You can convert `java` code into `groovy`; in addition, each line of statement can be without a semicolon at the end, `groovy` considers a line to be a statement. The `gremlin(groovy)` written by the user in `HugeGraph-Studio` can refer to the `java` code in this document, and some examples will be given below. -### 1 HugeGraph-Client +### 1 HugeGraph-Java-Client -HugeGraph-Client is the general entry for operating graph. Users must first create a HugeGraph-Client object and establish a connection (pseudo connection) with HugeGraph-Server before they can obtain the operation entry objects of schema, graph and gremlin. +HugeGraph-Java-Client is the general entry for operating graph. Users must first create a HugeGraph-Client object and establish a connection (pseudo connection) with HugeGraph-Server before they can obtain the operation entry objects of schema, graph and gremlin. Currently, HugeGraph-Client only allows connections to existing graphs on the server, and cannot create custom graphs. Its creation method is as follows: diff --git a/docs/api/restful-api/_category_.json b/docs/clients/restful-api/_category_.json similarity index 100% rename from docs/api/restful-api/_category_.json rename to docs/clients/restful-api/_category_.json diff --git a/docs/api/restful-api/auth.md b/docs/clients/restful-api/auth.md similarity index 99% rename from docs/api/restful-api/auth.md rename to docs/clients/restful-api/auth.md index e567f935..be572880 100644 --- a/docs/api/restful-api/auth.md +++ b/docs/clients/restful-api/auth.md @@ -1,5 +1,5 @@ --- -id: 'authentication' +id: 'auth' title: 'Authentication API' sidebar_label: 'Authentication' sidebar_position: 16 diff --git a/docs/api/restful-api/cypher.md b/docs/clients/restful-api/cypher.md similarity index 100% rename from docs/api/restful-api/cypher.md rename to docs/clients/restful-api/cypher.md diff --git a/docs/api/restful-api/edge.md b/docs/clients/restful-api/edge.md similarity index 100% rename from docs/api/restful-api/edge.md rename to docs/clients/restful-api/edge.md diff --git a/docs/api/restful-api/edgelabel.md b/docs/clients/restful-api/edgelabel.md similarity index 99% rename from docs/api/restful-api/edgelabel.md rename to docs/clients/restful-api/edgelabel.md index d9ad3656..79e173d3 100644 --- a/docs/api/restful-api/edgelabel.md +++ b/docs/clients/restful-api/edgelabel.md @@ -311,4 +311,4 @@ DELETE http://localhost:8080/graphs/hugegraph/schema/edgelabels/created Note: -> You can query the execution status of an asynchronous task by using `GET http://localhost:8080/graphs/hugegraph/tasks/1` (where "1" is the task_id). For more information, refer to the [Asynchronous Task RESTful API](../task). +> You can query the execution status of an asynchronous task by using `GET http://localhost:8080/graphs/hugegraph/tasks/1` (where "1" is the task_id). For more information, refer to the [Asynchronous Task RESTful API](./task). diff --git a/docs/api/restful-api/graphs.md b/docs/clients/restful-api/graphs.md similarity index 100% rename from docs/api/restful-api/graphs.md rename to docs/clients/restful-api/graphs.md diff --git a/docs/api/restful-api/gremlin.md b/docs/clients/restful-api/gremlin.md similarity index 98% rename from docs/api/restful-api/gremlin.md rename to docs/clients/restful-api/gremlin.md index bc7be759..af2abca8 100644 --- a/docs/api/restful-api/gremlin.md +++ b/docs/clients/restful-api/gremlin.md @@ -225,7 +225,7 @@ Note: Note: -> You can query the execution status of an asynchronous task by using `GET http://localhost:8080/graphs/hugegraph/tasks/1` (where "1" is the task_id). For more information, refer to the [Asynchronous Task RESTful API](../task). +> You can query the execution status of an asynchronous task by using `GET http://localhost:8080/graphs/hugegraph/tasks/1` (where "1" is the task_id). For more information, refer to the [Asynchronous Task RESTful API](./task). **Querying edges** @@ -256,4 +256,4 @@ Note: Note: -> You can query the execution status of an asynchronous task by using `GET http://localhost:8080/graphs/hugegraph/tasks/2` (where "2" is the task_id). For more information, refer to the [Asynchronous Task RESTful API](../task). +> You can query the execution status of an asynchronous task by using `GET http://localhost:8080/graphs/hugegraph/tasks/2` (where "2" is the task_id). For more information, refer to the [Asynchronous Task RESTful API](./task). diff --git a/docs/clients/restful-api/index.md b/docs/clients/restful-api/index.md new file mode 100644 index 00000000..25a6442a --- /dev/null +++ b/docs/clients/restful-api/index.md @@ -0,0 +1,9 @@ +--- +id: 'restful-api-index' +title: 'RESTFul API' +sidebar_position: 0 +--- + +import DocCardList from '@theme/DocCardList'; + +<DocCardList /> diff --git a/docs/api/restful-api/indexlabel.md b/docs/clients/restful-api/indexlabel.md similarity index 98% rename from docs/api/restful-api/indexlabel.md rename to docs/clients/restful-api/indexlabel.md index 7beabe4e..c75504b5 100644 --- a/docs/api/restful-api/indexlabel.md +++ b/docs/clients/restful-api/indexlabel.md @@ -174,4 +174,4 @@ DELETE http://localhost:8080/graphs/hugegraph/schema/indexlabels/personByCity Note: -> You can query the execution status of an asynchronous task by using `GET http://localhost:8080/graphs/hugegraph/tasks/1` (where "1" is the task_id). For more information, refer to the [Asynchronous Task RESTful API](../task). +> You can query the execution status of an asynchronous task by using `GET http://localhost:8080/graphs/hugegraph/tasks/1` (where "1" is the task_id). For more information, refer to the [Asynchronous Task RESTful API](./task). diff --git a/docs/api/restful-api/metrics.md b/docs/clients/restful-api/metrics.md similarity index 100% rename from docs/api/restful-api/metrics.md rename to docs/clients/restful-api/metrics.md diff --git a/docs/api/restful-api/other.md b/docs/clients/restful-api/other.md similarity index 100% rename from docs/api/restful-api/other.md rename to docs/clients/restful-api/other.md diff --git a/docs/api/restful-api/propertykey.md b/docs/clients/restful-api/propertykey.md similarity index 100% rename from docs/api/restful-api/propertykey.md rename to docs/clients/restful-api/propertykey.md diff --git a/docs/api/restful-api/rank.md b/docs/clients/restful-api/rank.md similarity index 100% rename from docs/api/restful-api/rank.md rename to docs/clients/restful-api/rank.md diff --git a/docs/api/restful-api/rebuild.md b/docs/clients/restful-api/rebuild.md similarity index 88% rename from docs/api/restful-api/rebuild.md rename to docs/clients/restful-api/rebuild.md index 86714094..3f6febea 100644 --- a/docs/api/restful-api/rebuild.md +++ b/docs/clients/restful-api/rebuild.md @@ -30,7 +30,7 @@ PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/indexlabels/personByCity ``` Note: -> You can get the asynchronous job status by `GET http://localhost:8080/graphs/hugegraph/tasks/${task_id}` (the task_id here should be 1). See More [AsyncJob RESTfull API](../task) +> You can get the asynchronous job status by `GET http://localhost:8080/graphs/hugegraph/tasks/${task_id}` (the task_id here should be 1). See More [AsyncJob RESTfull API](./task) #### 1.6.2 Rebulid all Indexs of VertexLabel @@ -56,7 +56,7 @@ PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/vertexlabels/person Note: -> You can get the asynchronous job status by `GET http://localhost:8080/graphs/hugegraph/tasks/${task_id}` (the task_id here should be 2). See More [AsyncJob RESTfull API](../task) +> You can get the asynchronous job status by `GET http://localhost:8080/graphs/hugegraph/tasks/${task_id}` (the task_id here should be 2). See More [AsyncJob RESTfull API](./task) #### 1.6.3 Rebulid all Indexs of EdgeLabel @@ -82,4 +82,4 @@ PUT http://localhost:8080/graphs/hugegraph/jobs/rebuild/edgelabels/created Note: -> You can get the asynchronous job status by `GET http://localhost:8080/graphs/hugegraph/tasks/${task_id}` (the task_id here should be 3). See More [AsyncJob RESTfull API](../task) \ No newline at end of file +> You can get the asynchronous job status by `GET http://localhost:8080/graphs/hugegraph/tasks/${task_id}` (the task_id here should be 3). See More [AsyncJob RESTfull API](./task) \ No newline at end of file diff --git a/docs/api/restful-api/schema.md b/docs/clients/restful-api/schema.md similarity index 100% rename from docs/api/restful-api/schema.md rename to docs/clients/restful-api/schema.md diff --git a/docs/api/restful-api/task.md b/docs/clients/restful-api/task.md similarity index 96% rename from docs/api/restful-api/task.md rename to docs/clients/restful-api/task.md index dc6e12ed..713206c4 100644 --- a/docs/api/restful-api/task.md +++ b/docs/clients/restful-api/task.md @@ -94,7 +94,7 @@ DELETE http://localhost:8080/graphs/hugegraph/tasks/2 #### 7.1.4 Cancel an async task, **the task should be able to be canceled** -If you already created an async task via [Gremlin API](../gremlin) as follows: +If you already created an async task via [Gremlin API](./gremlin) as follows: ```groovy "for (int i = 0; i < 10; i++) {" + diff --git a/docs/api/restful-api/traverser.md b/docs/clients/restful-api/traverser.md similarity index 100% rename from docs/api/restful-api/traverser.md rename to docs/clients/restful-api/traverser.md diff --git a/docs/api/restful-api/variable.md b/docs/clients/restful-api/variable.md similarity index 100% rename from docs/api/restful-api/variable.md rename to docs/clients/restful-api/variable.md diff --git a/docs/api/restful-api/vertex.md b/docs/clients/restful-api/vertex.md similarity index 100% rename from docs/api/restful-api/vertex.md rename to docs/clients/restful-api/vertex.md diff --git a/docs/api/restful-api/vertexlabel.md b/docs/clients/restful-api/vertexlabel.md similarity index 99% rename from docs/api/restful-api/vertexlabel.md rename to docs/clients/restful-api/vertexlabel.md index 8530ab77..9d2cbdeb 100644 --- a/docs/api/restful-api/vertexlabel.md +++ b/docs/clients/restful-api/vertexlabel.md @@ -308,4 +308,4 @@ DELETE http://localhost:8080/graphs/hugegraph/schema/vertexlabels/person Note: -> You can use `GET http://localhost:8080/graphs/hugegraph/tasks/1` (where "1" is the task_id) to query the execution status of the asynchronous task. For more information, refer to the [Asynchronous Task RESTful API](../task). +> You can use `GET http://localhost:8080/graphs/hugegraph/tasks/1` (where "1" is the task_id) to query the execution status of the asynchronous task. For more information, refer to the [Asynchronous Task RESTful API](./task). diff --git a/docs/config/config-authentication.md b/docs/config/config-authentication.md index d168a087..9bf416cf 100644 --- a/docs/config/config-authentication.md +++ b/docs/config/config-authentication.md @@ -72,7 +72,7 @@ In the `hugegraph{n}.properties` configuration file, configure the `gremlin.grap gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy ``` -For detailed API calls and explanations regarding permissions, please refer to the [Authentication-API](/docs/clients/restful-api/auth) documentation. +For detailed API calls and explanations regarding permissions, please refer to the [Authentication-API](../clients/restful-api/auth) documentation. ### Custom User Authentication System diff --git a/docs/config/config-guide.md b/docs/config/config-guide.md index c5194ede..8e85f761 100644 --- a/docs/config/config-guide.md +++ b/docs/config/config-guide.md @@ -138,7 +138,7 @@ ssl: { There are many configuration options mentioned above, but for now, let's focus on the following options: `channelizer` and `graphs`. - `graphs`: This option specifies the graphs that need to be opened when the GremlinServer starts. It is a map structure where the key is the name of the graph and the value is the configuration file path for that graph. -- `channelizer`: The GremlinServer supports two communication modes with clients: WebSocket and HTTP (default). If WebSocket is chosen, users can quickly experience the features of HugeGraph using [Gremlin-Console](/clients/gremlin-console.html), but it does not support importing large-scale data. It is recommended to use HTTP for communication, as all peripheral components of HugeGraph are implemented based on HTTP. +- `channelizer`: The GremlinServer supports two communication modes with clients: WebSocket and HTTP (default). If WebSocket is chosen, users can quickly experience the features of HugeGraph using [Gremlin-Console](../clients/gremlin-console), but it does not support importing large-scale data. It is recommended to use HTTP for communication, as all peripheral components of HugeGraph are implemented based on HTTP. By default, the GremlinServer serves at `localhost:8182`. If you need to modify it, configure the `host` and `port` settings. diff --git a/docs/contribution-guidelines/contribute.md b/docs/contribution-guidelines/contribute.md index 0cd893e8..73692871 100644 --- a/docs/contribution-guidelines/contribute.md +++ b/docs/contribution-guidelines/contribute.md @@ -73,7 +73,7 @@ vim hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java # run test locally (optional) mvn test -Pcore-test,memory ``` -Note: In order to be consistent with the code style easily, if you use [IDEA](https://www.jetbrains.com/idea/) as your IDE, you can directly [import](https://www.jetbrains.com/help/idea/configuring-code-style.html) our code style [configuration file](./hugegraph-style.xml). +Note: In order to be consistent with the code style easily, if you use [IDEA](https://www.jetbrains.com/idea/) as your IDE, you can directly [import](https://www.jetbrains.com/help/idea/configuring-code-style.html) our code style [configuration file](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-style.xml). ##### 3.2.1 Check licenses If we want to add new third-party dependencies to the `HugeGraph` project, we need to do the following things: diff --git a/docs/language/hugegraph-example.md b/docs/language/hugegraph-example.md index 0656b4a2..01764cf3 100644 --- a/docs/language/hugegraph-example.md +++ b/docs/language/hugegraph-example.md @@ -178,7 +178,7 @@ g.V(pluto).out('brother').as('god').out('lives').as('place').select('god','place g.V(pluto).out('brother').as('god').out('lives').as('place').select('god','place').by('name') ``` -推荐使用[HugeGraph-Studio](/docs/quickstart/hugegraph-studio) 通过可视化的方式来执行上述代码。另外也可以通过HugeGraph-Client、HugeApi、GremlinConsole和GremlinDriver等多种方式执行上述代码。 +推荐使用[HugeGraph-Hubble](../quickstart/hugegraph-hubble) 通过可视化的方式来执行上述代码。另外也可以通过HugeGraph-Client、HugeApi、GremlinConsole和GremlinDriver等多种方式执行上述代码。 #### 3.2 总结 diff --git a/docs/quickstart/hugegraph-client.md b/docs/quickstart/hugegraph-client.md index 388d7232..e0203c6f 100644 --- a/docs/quickstart/hugegraph-client.md +++ b/docs/quickstart/hugegraph-client.md @@ -10,7 +10,7 @@ sidebar_position: 4 [HugeGraph-Client](https://github.com/apache/hugegraph-toolchain) sends HTTP request to HugeGraph-Server to obtain and parse the execution result of Server. We support HugeGraph-Client for Java/Go/[Python](https://github.com/apache/incubator-hugegraph-ai/tree/main/hugegraph-python-client) language. -You can use [Client-API](/cn/docs/clients/hugegraph-client) to write code to operate HugeGraph, such as adding, deleting, modifying, and querying schema and graph data, or executing gremlin statements. +You can use [Client-API](../clients/java-client) to write code to operate HugeGraph, such as adding, deleting, modifying, and querying schema and graph data, or executing gremlin statements. > [HugeGraph client SDK tool based on Go > language](https://github.com/apache/incubator-hugegraph-toolchain/blob/master/hugegraph-client-go/README.en.md) > (version >=1.2.0) @@ -352,5 +352,5 @@ Before running Example, you need to start the Server. For the startup process, s ### 4.5 More Information About Client-API -See[Introduce basic API of HugeGraph-Client](/docs/clients/hugegraph-client). +See[Introduce basic API of HugeGraph-Client](../clients/java-client). diff --git a/docs/quickstart/hugegraph-hubble.md b/docs/quickstart/hugegraph-hubble.md index 96e413d0..4f3e8818 100644 --- a/docs/quickstart/hugegraph-hubble.md +++ b/docs/quickstart/hugegraph-hubble.md @@ -40,7 +40,7 @@ functions to achieve unified management and result viewing of asynchronous tasks ##### Data Import > "Note: The data import function is currently suitable for preliminary use. > For formal data import, -> please use [hugegraph-loader](/docs/quickstart/hugegraph-loader), which has much better performance, stability, and functionality." +> please use [hugegraph-loader](../quickstart/hugegraph-loader), which has much better performance, stability, and functionality." Data import is to convert the user's business data into the vertices and edges of the graph and insert it into the graph database. The platform provides a wizard-style visual import module. @@ -286,7 +286,7 @@ Displays vertex and edge indices for vertex types and edge types. #### 4.3 Data Import -> **Note**：currently, we recommend to use [hugegraph-loader](/en/docs/quickstart/hugegraph-loader) to import data formally. The built-in import of `hubble` is used for **testing** and **getting started**. +> **Note**：currently, we recommend to use [hugegraph-loader](../quickstart/hugegraph-loader) to import data formally. The built-in import of `hubble` is used for **testing** and **getting started**. The usage process of data import is as follows: diff --git a/docs/quickstart/hugegraph-loader.md b/docs/quickstart/hugegraph-loader.md index fea96615..1bf11c3d 100644 --- a/docs/quickstart/hugegraph-loader.md +++ b/docs/quickstart/hugegraph-loader.md @@ -18,7 +18,7 @@ Local disk files and HDFS files support resumable uploads. It will be explained in detail below. -> Note: HugeGraph-Loader requires HugeGraph Server service, please refer to [HugeGraph-Server Quick Start](./docs/quickstart/hugegraph-server) to download and start Server +> Note: HugeGraph-Loader requires HugeGraph Server service, please refer to [HugeGraph-Server Quick Start](../quickstart/hugegraph-server) to download and start Server ### 2 Get HugeGraph-Loader @@ -139,7 +139,7 @@ schema.edgeLabel("knows").sourceLabel("person").targetLabel("person").ifNotExist schema.edgeLabel("created").sourceLabel("person").targetLabel("software").ifNotExist().create(); ``` -> Please refer to the corresponding section in [hugegraph-client](./docs/clients/hugegraph-client) for the detailed description of the schema. +> Please refer to the corresponding section in [hugegraph-client](./hugegraph-client) for the detailed description of the schema. #### 3.2 Prepare data diff --git a/docs/quickstart/hugegraph-server.md b/docs/quickstart/hugegraph-server.md index a30a334f..47c287dc 100644 --- a/docs/quickstart/hugegraph-server.md +++ b/docs/quickstart/hugegraph-server.md @@ -674,7 +674,7 @@ response body: <p id="swaggerui-example"></p> -For detailed API, please refer to [RESTful-API](/docs/clients/restful-api) +For detailed API, please refer to [RESTful-API](../clients/restful-api) You can also visit `localhost:8080/swagger-ui/index.html` to check the API. @@ -697,4 +697,4 @@ $bin/stop-hugegraph.sh ### 8 Debug Server with IntelliJ IDEA -Please refer to [Setup Server in IDEA](./docs/contribution-guidelines/hugegraph-server-idea-setup) +Please refer to [Setup Server in IDEA](../contribution-guidelines/idea-setup) diff --git a/docs/quickstart/index.md b/docs/quickstart/index.md new file mode 100644 index 00000000..fd202092 --- /dev/null +++ b/docs/quickstart/index.md @@ -0,0 +1,9 @@ +--- +id: 'quickstart-index' +title: 'QuickStart' +sidebar_position: 0 +--- + +import DocCardList from '@theme/DocCardList'; + +<DocCardList /> diff --git a/package.json b/package.json index e910bb6d..34be5de3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "apache-hugegraph-doc", - "version": "1.3.0", + "version": "dev", "private": true, "scripts": { "docusaurus": "docusaurus",
