apache / apache/incubator-graphar

[Doc] [Improvement] Provide tutorials on using GraphAr libraries in documentation

Open
#168 3 comments 0 reactions 0 assignees View on GitHub
Component:Documentation enhancement good first issue
Dominant language
C++
Stars
373
Forks
93
Avg merge
7d 21h
Merged PRs (30d)
7

Description

**Is your feature request related to a problem? Please describe.**
The GraphAr project currently offers the C++ library and the Spark library, with "Getting Started" and "API References" available in the [documentation](https://alibaba.github.io/GraphAr/index.html). However, these references may not suffice for developers to quickly and intuitively understand the usage of the libraries.

**Describe the solution you'd like**
To address this, we propose adding tutorials on how to use the libraries in the documentation. These tutorials can be organized by programming language and separated into independent units for introducing different classes. As a first step, we can add tutorials on Info classes, such as GraphInfo, VertexInfo, and EdgeInfo.

For reference, we recommend to read [Apache Arrow's documentation](https://arrow.apache.org/docs/cpp/user_guide.html) to learn about how to write the tutorials.

This is also a good first issue to get familiar with and get into making contributions to the GraphAr libraries.

Contributor guide

Open the contributing guide

Research direction

Start with the GraphAr documentation's Getting Started and API References pages, then read Apache Arrow's C++ user guide for tutorial structure. Define the first tutorial units around GraphInfo, VertexInfo, and EdgeInfo, organized by the relevant programming language and library; done means these usage tutorials are added to the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, spark
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.