GithubHelp home page GithubHelp logo

vesoft-inc / nebula-docs Goto Github PK

View Code? Open in Web Editor NEW
49.0 29.0 73.0 13.5 GB

Documentations for the Nebula Graph project

Home Page: https://docs.nebula-graph.io/

License: Apache License 2.0

CSS 14.09% JavaScript 23.56% HTML 46.17% Shell 3.42% Python 12.76%

nebula-docs's Introduction

NebulaGraph documentation

Contributing

If you have any questions on our documentation, feel free to raise an Issue or directly create a Pull Request to help fix or update it. See NebulaGraph CONTRIBUTING guide to get started.

nebula-docs's People

Contributors

abby-cyber avatar aiee avatar akihi99 avatar amber1990zhang avatar chrischen2023 avatar cooper-lzy avatar easesu avatar foesa-yang avatar greyli avatar izhuxiaoqing avatar jamieliu1023 avatar jude-zhu avatar jyf111 avatar kun8018 avatar lalagreat avatar liuxue-yang avatar manyfeatures avatar nianiajr avatar nicolacage avatar oldlady344 avatar oldpanda avatar qingz11 avatar randomjoe211 avatar sbstnerhrdt avatar sherman-the-tank avatar superyoko avatar whitewum avatar xiajingchun avatar yang-hub 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

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  avatar  avatar  avatar  avatar

nebula-docs's Issues

change `v2-preview` to `v2.0.0-alpha` in the doc

Error Report

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. What is the URL/path of the document related to this issue?

  2. How would you like to improve it?

Checklist

  • I searched for existing GitHub issues
  • I updated Nebula Graph to most recent version
  • I included all the necessary information above

metad is crashed after upgrade from v1

refer vesoft-inc/nebula#3179

https://github.com/vesoft-inc/nebula/blob/master/src/daemons/MetaDaemon.cpp#L203

  1. when upgrade from v1 to v2, should also copy share/resources/date_time_zonespec.csv
  2. if we don't copy this file, after upgrade to v3, metad would be crashed.
I20220124 12:04:05.535204 41389 RootUserMan.h:27] Root user exists
I20220124 12:04:05.535235 41487 JobManager.cpp:116] JobManager::runJobBackground() enter
E20220124 12:04:05.535521 41389 MetaDaemon.cpp:202] Invalid timezone file `share/resources/date_time_zonespec.csv', exception: `Unable to locate or access the required datafile. Filespec: share/resources/date_time_zonespec.csv'.
I20220124 12:04:05.540473 41389 JobManager.cpp:104] JobManager::shutDown() begin
I20220124 12:04:05.545461 41487 JobManager.cpp:121] [JobManager] detect shutdown called, exit
E20220124 12:04:05.545740 41487 JobDescription.cpp:181] Loading Job Description FailedE_KEY_NOT_FOUND
E20220124 12:04:05.545814 41487 JobManager.cpp:129] [JobManager] load an invalid job from queue 0
I20220124 12:04:05.546111 41389 JobManager.cpp:112] JobManager::shutDown() end

No br directory

git clone https://github.com/vesoft-inc/nebula-storage.git
cd nebula-storage/util/br

no util directory?
image

What is fixed_string mean in vid_type?

Hi, In documentation of CRUD section, there is a notation that we should define vid_type, which could be FIXED_STRING(N). My question is about N parameter. What happens, when we define for example N = 10 then we put a key with length N = 2? Are those extra 8 bytes allocated and we have waste of disk usage or they will be ignored and just (2 * size of string) is allocated?

Nebula Studio deployment should be included 2.*

Could we prioritize to smooth the studio docker deployment (after we removed the nebula-web-docker being removed) as we did in docs-cn: translate the studio deployment chapters, user may confuse with this as the web docker repo will be redirected to nebula-studio source repo while there is no English-doc right now.

There are binary packages here(https://nebula-graph.io/release/?studio#3.0.0), while for 2.0.0 there are no docs to be referred(and simply yum install may not be that smooth w/o extra steps :-) ).

Thanks!

context: https://discuss.nebula-graph.io/t/connecting-to-nebula-studio/1042

Checklist

  • I searched for existing GitHub issues
  • I updated Nebula Graph to most recent version
  • I included all the necessary information above

Having a single page index of all query syntax

Could we have a single page index that covers all query syntax in one overview, which will be very very helpful for a new user that has little concept of all nGQL capabilities(thus they don't know which keyword to start with/search)?

Thanks!

Enas Al Kawasmi 11 minutes ago
I found it after really struggling

Enas Al Kawasmi 10 minutes ago
I think their should be a direct link from the get started page to the ngql index

BZip2 is required for compiling Nebula Graph

Error Report

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. What is the URL/path of the document related to this issue?

https://docs.nebula-graph.io/master/4.deployment-and-installation/1.resource-preparations/#software_requirements_for_compiling_nebula_graph

  1. How would you like to improve it?

BZip2 is required for compiling Nebula Graph[1], but it is not listed in the software requirements document

>  cmake -DCMAKE_BUILD_TYPE=Debug -G "CodeBlocks - Unix Makefiles" -DENABLE_BUILD_STORAGE=ON -Wno-dev .. 
>>>> Options of Nebula Graph <<<<
...
>>>> Configuring third party for 'Nebula Graph' <<<<
-- Downloading prebuilt third party automatically...
-- cxx_cmd: /usr/local/bin/g++ -D_GLIBCXX_USE_CXX11_ABI=1
Downloading vesoft-third-party-2.0-x86_64-libc-2.17-gcc-7.1.0-abi-11.sh...
Downloading vesoft-third-party-2.0-x86_64-libc-2.17-gcc-7.1.0-abi-11.sh failed
-- CMAKE_INCLUDE_PATH              : 
-- CMAKE_LIBRARY_PATH              : 
-- CMAKE_PROGRAM_PATH              : 
-- GLIBC_VERSION                   : 2.17

CMake Error at modules/common/cmake/FindBzip2.cmake:31 (message):
  Bzip2 doesn't exist           <-- BZip2 is required
Call Stack (most recent call first):
  modules/common/cmake/nebula/ThirdPartyConfig.cmake:81 (find_package)
  CMakeLists.txt:97 (include)
...

Checklist

  • I searched for existing GitHub issues
  • I updated Nebula Graph to most recent version
  • I included all the necessary information above

cpp build doc is not correct ( for v2-alpha)

Error Report

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. What is the URL/path of the document related to this issue?

  2. How would you like to improve it?

Checklist

  • I searched for existing GitHub issues
  • I updated Nebula Graph to most recent version
  • I included all the necessary information above

英文版文档的网页左侧导航栏中 Introduction 的第二个子项应该是Data Model 而不是 Date Model

Error Report

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. What is the URL/path of the document related to this issue?

  2. How would you like to improve it?

Checklist

  • I searched for existing GitHub issues
  • I updated Nebula Graph to most recent version
  • I included all the necessary information above

More best practices is supported in the documentation.

Change Request

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.
    Reason:some users use session incorrectly, resulting in poor performance.We need some best practice guidance to help users avoid.

  2. Describe your suggestion or addition.
    Add more best practices in documentation.

  3. Provide some reference materials (documents, websites, etc) if you could.

The v2.0.1 version is shown as "under development" in the English website

Error Report

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. What is the URL/path of the document related to this issue?

https://docs.nebula-graph.io/2.0.1/

  1. How would you like to improve it?

Seem that the document of v2.0.1 is not set properly. There is a popup at the top of the website. I think v2.0.1 is the latest stable release version?

image

image

Checklist

  • I searched for existing GitHub issues
  • I updated Nebula Graph to most recent version
  • I included all the necessary information above

List and add detail explanation of nebula graph metrics

Change Request

  1. Describe what you find is inappropriate or missing in the existing docs.
    In https://docs.nebula-graph.io/3.0.0/6.monitor-and-metrics/1.query-performance-metrics/, it doesn't show what metrics are provided by nebula and each metric's explanation now.

  2. Describe your suggestion or addition.
    I think metics are helpful for monitoring. Can we add each nebula metric and its explanation like https://docs.nebula-graph.io/3.0.0/nebula-dashboard-ent/7.monitor-parameter/

  3. Provide some reference materials (documents, websites, etc) if you could.
    N/A

NebulaGraph2.0如何在Linux aarch64系统下离线编译

Question

This repository is ONLY used to solve issues related to DOCS.

Before submitting your question, make sure you have:

  • Searched existing Stack Overflow questions.
  • Googled your question.
  • Searched the open and closed GitHub issues.
  • Searched our Forum.
  • Read the documentation:

Now, please describe your question here:

①问题链接
NebulaGraph的论坛链接如下:
https://discuss.nebula-graph.com.cn/t/topic/3836/33
②需求描述
亟待NebulaGraph官方出一个ARM架构下针对NG2.0编译的文档,方便社区小伙伴针对此问题可以快速处理,避免重复跳坑

The description of ttl in meta service need to be adjusted

Change Request

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.
    Current description:
    The Meta Service provides automatic data eviction and space reclamation based on TTL (time to live) options for Nebula Graph.

Suggest:
The meta service is only store TTL definition information.When the data expires and need to be cleaned up,it is handled by storage service.

  1. Describe your suggestion or addition.

  2. Provide some reference materials (documents, websites, etc) if you could.

Placeholder in version 2.x edge data format description adjustment

Change Request

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.
    It is not appropriate for placeholder to keep for TOSS.The TOSS implementation does not rely on this placeholder.

  2. Describe your suggestion or addition.
    Drop the description of placeholder.

  3. Provide some reference materials (documents, websites, etc) if you could.

28E4CCA7-6251-4545-8B1E-276F63E1C374

Strongly suggest introduce same search solution in 2.5(quite usable!) to legacy versions like 2.0.1

As title, the old search in 2.0.1(google search based) is not that user-friendly, and users cannot even find one simple syntax with it, while there is indeed someone out there checking v2.0.1 docs(maybe their production nebula is) get tortured by this :-).

context: one of our new user complaints on:

"Where on earth I can get to the complete manual of NGQL. I have been searching the documents from the overview till the last page I cannot find a simple way that gets me to a statement syntax. for example DROP EDGE where is that and how to get to it

Thanks!

Add manual about `go from <vid> over *`

Change Request

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.

  2. Describe your suggestion or addition.

  3. Provide some reference materials (documents, websites, etc) if you could.

Highlight in `balance data` related chapters on how to enable this feature

Change Request

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.

User queried this on how the feature is still not usable in 3.1

  1. Describe your suggestion or addition.

We could add notices to make them aware of how it's not turned on by default and where to switch it on.

  1. Provide some reference materials (documents, websites, etc) if you could.

test

Error Report

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. What is the URL/path of the document related to this issue?

  2. How would you like to improve it?

Checklist

  • I searched for existing GitHub issues
  • I updated Nebula Graph to the most recent version
  • I included all the necessary information above

Browser prompt not secure

Error Report

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. What is the URL/path of the document related to this issue?
    https://docs.nebula-graph.io/

  2. How would you like to improve it?

image

Checklist

  • [x ] I searched for existing GitHub issues
  • I updated Nebula Graph to most recent version
  • I included all the necessary information above

error link addr

image

to new repo

Checklist

  • I searched for existing GitHub issues
  • I updated Nebula Graph to most recent version
  • I included all the necessary information above

Recommended to add a description in BALANCE DATA

Error Report

This repository is ONLY used to solve issues related to DOCS.

Please answer the following questions before submitting your issue. Thanks!

  1. What is the URL/path of the document related to this issue?
    https://docs.nebula-graph.com.cn/3.2.0/synchronization-and-migration/2.balance-syntax/

  2. How would you like to improve it?
    It is recommended to add a description in BALANCE DATA: This feature belongs to the Enterprise Edition

Checklist

  • I searched for existing GitHub issues
  • I updated NebulaGraph to most recent version
  • I included all the necessary information above

Logging mechanism description

There is no any information about how we can set/change logrotate mechanism in nebula components.
There are many files with names like nebula-storaged.nebula-3.root.log.ERROR.20210922-133823.1218 and they aren't going to delete during the time and they are just rotated. how we can change this mechanism? just with custom logrotate in OS level? How can we change the naming mechanism of logs?

Docs search with site:google.com doesn't work well as native search in docs-cn

Change Request

  1. Describe what you find is inappropriate or missing in the existing docs.

It seems searching now in docs-en doesn't work well, it indexed things:

  • contents other than only docs.nebula-graph.io
  • contents other than currently selected version
  1. Describe your suggestion or addition.
    Could we use native search as it is in docs-cn?

  2. Provide some reference materials (documents, websites, etc) if you could.
    as above.

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.