Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Minor] Add discord invite link and banner to README #129

Merged
merged 2 commits into from
Mar 30, 2023
Merged

[Minor] Add discord invite link and banner to README #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46f160b
Fullfill the community of GraphAr
acezen Mar 30, 2023
4eb9b0a
Tiny fix
acezen Mar 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 28 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
GraphAr
========

|GraphAr CI| |Docs CI| |GraphAr Docs|
|GraphAr CI| |Docs CI| |GraphAr Docs| |Discord|

Welcome to GraphAr (short for "Graph Archive"), an open source, standardized file format for graph data storage and retrieval.

Expand Down Expand Up @@ -128,10 +128,26 @@ The Spark Library
See `GraphAr Spark Library`_ for details about the Spark library.


Contributing to GraphAr
----------------------------
Contributing
-------------

Contributing Guidelines
^^^^^^^^^^^^^^^^^^^^^^^^

Read through our `contribution guidelines`_ to learn about our submission process, coding rules, and more.

Code of Conduct
^^^^^^^^^^^^^^^^

Help us keep GraphAr open and inclusive. Please read and follow our `Code of Conduct`_.

Community
---------

Join the conversation and help the community.

- `Discord`_

See `Contribution Guide`_ for details on submitting patches and the contribution workflow.

License
-------
Expand All @@ -151,6 +167,9 @@ third-party libraries may not have the same license as GraphAr.
.. |GraphAr Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
:target: https://alibaba.github.io/GraphAr/

.. |Discord| image:: https://img.shields.io/discord/1088377726634836051.svg?logo=discord&logoColor=fff&label=Discord&color=7389d8
:target: https://discord.gg/XPsfd4ShCu

.. |Overview Pic| image:: https://alibaba.github.io/GraphAr/_images/overview.png
:width: 650
:alt: Overview
Expand Down Expand Up @@ -187,7 +206,11 @@ third-party libraries may not have the same license as GraphAr.

.. _example files: https://github.com/GraphScope/gar-test/blob/main/ldbc_sample/

.. _Contribution Guide: https://alibaba.github.io/GraphAr/user-guide/contributing.html
.. _contribution guidelines: https://alibaba.github.io/GraphAr/user-guide/contributing.html

.. _Code of Conduct: https://github.com/alibaba/GraphAr/blob/main/CODE_OF_CONDUCT.md

.. _Discord: https://discord.gg/XPsfd4ShCu

.. _GitHub Issues: https://github.com/alibaba/GraphAr/issues/new

Expand Down
4 changes: 2 additions & 2 deletions spark/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This directory contains the code and build system for the GraphAr Spark library.


Building GraphAr Spark
--------------------
----------------------

System setup
^^^^^^^^^^^^^
Expand Down Expand Up @@ -69,7 +69,7 @@ Building the API document with maven:
The API document is generated in the directory ``spark/target/site/scaladocs``.

How to use
^^^^^^^^^^^
-----------

Please refer to our `GraphAr Spark Library Documentation`_.

Expand Down