Giter Site home page Giter Site logo

vesoft-inc / nebula-docs-cn Goto Github PK

View Code? Open in Web Editor NEW
52.0 25.0 92.0 23.13 GB

Repository for the Chinese documentations

Home Page: https://docs.nebula-graph.com.cn/

License: Apache License 2.0

CSS 0.87% JavaScript 21.73% Shell 0.55% HTML 65.35% TypeScript 4.70% Less 1.77% Python 5.01%
hacktoberfest

nebula-docs-cn's Introduction

Publish docs via GitHub Pages

NebulaGraph 文档

贡献文档

如果发现文档问题,请随时创建一个 Issue 告知我们或直接创建一个 PR 修复或更新。请参阅 NebulaGraph 中文文档贡献指南开始贡献。

nebula-docs-cn's People

Contributors

abby-cyber avatar akihi99 avatar amber1990zhang avatar cooper-lzy avatar dbacyj avatar dependabot[bot] avatar foesa-yang avatar greyli avatar harrischu avatar hetao92 avatar izhuxiaoqing avatar jamieliu1023 avatar jayson-huang avatar jude-zhu avatar jyz0309 avatar kun8018 avatar laura-ding avatar nianiajr avatar nicole00 avatar oldlady344 avatar qingz11 avatar randomjoe211 avatar shinji-ikarig avatar sophie-xie avatar study-day avatar tongheihei avatar wey-gu avatar whitewum avatar xiajingchun avatar yixinglu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

nebula-docs-cn's Issues

highlights on metrics

This is worthy mentioned in metrics documentation:

It turns out that stats like num_add_vertices.sum.3600 are not actually vertices count, instead, it's the insert count when the batch size of the insert query is not 1, also, in & out also should be aware of in this case.

Thus, the SUM of num_add_vertices.sum.3600 of all storageD instances is not the actual vertices added of the corresponding period.


https://discuss.nebula-graph.com.cn/t/topic/4880/10?u=wey

Which I quoted @laura-ding 's clarification as below:

现在 metric 统计的 edge 和 vertex 的数量是向storage批量写入的次数,所以当你插入的query含有batch的时候,这个统计就不是实际的点边数量,而是batch数量(当然,边点时候,还有包含每条边的反向边)。假如你每个insert 语句只包含一个点或者一条边,那么,你把集群所有storage统计出来的数据就是点的插入数量,边的话,需要用总数除以2(因为有反向边)

cc @laura-ding

Description naming rules

Description naming rules for nGQL, such as space_name, tag_name, vertex_name, edge_name, prop_name. It just can include character, number, underline !?

Add latest alias for versioned URLs

We could consider adding an alias to the latest version of docs, this is helpful when we would like to refer some chapters(that's basically not changed among versions) always to its latest version.

This was triggered in discussion in this PR vesoft-inc/nebula#2476. cc @jamieliu1023 @yihong0618

It's feasible via https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#publishing-a-new-version, which I quote as below:

Publishing a new version¶
If you want to publish a new version of your project documentation, choose a version identifier and update the alias set as the default version with:

mike deploy --push --update-aliases 0.1 latest

Note that every version will be deployed as a subdirectory of your site_url, e.g.:

  • docs.example.com/0.1/
  • docs.example.com/0.2/
  • ...
    Setting a default version¶
    When starting with mike, a good idea is to set an alias as a default version, e.g. latest, and when publishing a new version, always update the alias to point to the latest version:
mike set-default --push latest

Thanks.

How about add spaces before and after each word?

直接用中文吧:)
我发现 nebula 中文文档在一些地方会有着英语风格不统一的问题。
举个例子:
升级历史版本到 v2.0.0之中
image
前面的 Storaged 的前后都会有空格,而在下文中的 Storaged 的前后却没有空格,这样会显得文档整体非常的乱 : )
和这个差不多的有挺多地方 😏
不如一起改一改?: )😏

Test Studio docs

Test the Studio docs for 2.2.0. If they are OK, release them.

Upsert document content error

image

In the use case of the upsert document, #1 and #3 need to add instructions.

The content of #2 needs to be updated. In the current upsert syntax, undefined variables are calculated by 0. The example is as follows.

image

Highlight somewhere in docs on property filter in bulk pattern's condition

It's easy for users to write:

incorrect

match path=(n:player{name: "Tim Duncan"})-[e:follow*1..2]-(m) \
    where e.degree > 0 \
    return path

rather than:

correct

match path=(n:player{name: "Tim Duncan"})-[e:follow*1..2]-(m) \
    where ALL(e_ in e WHERE e_.degree > 0) \
    return path

Could we put the correct expression somewhere(and in a highlighted way) in docs?

Add version warning for those docs pages w/o version info in URL?

It seems some old docs pages are with higher ranks in Google(which is normal) [1], could we possibly add warning info to avoid user refers to them wrongly as we did in those non-latest docs with the version in URL [2]?

[1] search "nebula graph 编译", first result is: https://docs.nebula-graph.com.cn/manual-CN/3.build-develop-and-administration/1.build/1.build-source-code/
[2] https://docs.nebula-graph.com.cn/1.2.0/ with warning:

Nebula Graph 内核 2.x 已发布。 Nebula Graph 内核 1.x 与 2.x数据格式、通信协议、客户端等均双向不兼容,代码仓库不相同。2.x 请参考新版本文档。

'shmId’ may be used uninitialized

Error below when typing $make following the doc
... FTIndexExecutor.cpp line 83 ... ‘shmId’ may be used uninitialized in this function [-Werror=maybe-uninitialized]

I add the following line at the beginning of src/executor/maintain/FTIndexExecutor.cpp

_Pragma ("GCC diagnostic ignored "-Wmaybe-uninitialized"")

and it works.

[question] about non-property index and property index

Dear,

From match-tag, it's stated that:

Tag的索引和属性的索引不同。如果Tag的某个属性有索引,但是Tag本身没有索引,用户无法基于该Tag执行MATCH语句。

While in create index, it mentioned that:

如果已经为"某个Tag T的属性A"建立过属性索引i_TA,则没有必要对于Tag T额外再建立一个Tag索引i_T。这是因为查询引擎可以使用i_TA来替代i_T。Edge type索引同理。但是,i_T却不能替代i_TA用于属性查找。

How should I understand this, please?
Thanks!
BR, Wey

CREATE SPACE创建空间不指定vid_type都会报错

使用默认值。

CREATE SPACE my_space_1;

指定分片数量。

CREATE SPACE my_space_2(partition_num=10);

指定副本数量。

CREATE SPACE my_space_3(replica_factor=1); 

以上方法都报错

[ERROR (-1009)]: SemanticError: space vid_type must be specified explicitly

[Format]: indented fenced code blocks escaped by basic code blocks

It's found some backticks fenced code blocks under the - separated lists were indented.

For the reason indentation itself is the semantics of the basic code block, thus the backticks fenced code blocks will end up being escaped like below [Example 0], also a PR #367 was created, could you please help see if it's the way to fix this(sorry, I didn't try it via mkdocs yet)?

Rendered Example 0
Renderred Example 0

Example 0

2. 检查主机上的GCC和CMake版本是否正确。版本信息请参见[软件要求](#_4)```bash
    $ g++ --version
    $ cmake --version
    ```

    如果版本正确,您可以跳过本小节。如果不正确,请根据如下步骤安装:

    1. 克隆仓库`nebula-common`到主机。

        ```bash
        $ git clone https://github.com/vesoft-inc/nebula-common.git
        ```

        类似{{ nebula.release }}版本的Nebula Graph源码存储在特定的分支,您可以使用`--branch``-b`选项指定克隆的分支。例如指定{{ nebula.release }},命令如下:

        ```bash
        $ git clone --branch v{{ nebula.release }} https://github.com/vesoft-inc/nebula-common.git
        ```

    2. 进入目录`nebula-common````bash
        $ cd nebula-common
        ```

Proposed Change would be to remove the indentation, which is not yet verified.

diff --git a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md
index ea083e7e..c68dbdae 100644
--- a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md
+++ b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md
@@ -114,36 +114,37 @@

     1. 克隆仓库`nebula-common`到主机。

-        ```bash
-        $ git clone https://github.com/vesoft-inc/nebula-common.git
-        ```
+    ```bash
+    $ git clone https://github.com/vesoft-inc/nebula-common.git
+    ```

Related Doc Pages:

The command to change password is a bit confusing.

The command to change password in the document:

CHANGE PASSWORD <user_name> FROM <old_psw> TO <new-psw>;

When I use then command

CHANGE PASSWORD root FROM nebula TO fjsdhGYHF@GGHF65fjkshfk;

then got the tip:

SyntaxError: syntax error near nebula'

After some attempts, I learned that the password field requires quotation marks, like this:

CHANGE PASSWORD root FROM "nebula" TO "fjsdhGYHF@GGHF65fjkshfk";

Therefore, I recommend adding examples after the commands in the documentation.

nGQL指南中遇到的LIMIT结合rand32(5)。

rand32(5)的结果是[0, 5)输出结果可能是0,所以会出现输出为空的时候。

(root@nebula) [basketballplayer]> MATCH (v:player) RETURN v.name AS Name, v.age AS Age ORDER BY Age LIMIT rand32(5);

输出为:

+------+-----+
| Name | Age |
+------+-----+
+------+-----+

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.