JanusGraph / JanusGraph/janusgraph

Document that third-party drivers should only use GraphSON serializer

Open
#4,127 0 comments 0 reactions 0 assignees View on GitHub
area/docs
Dominant language
Java
Stars
5.8k
Forks
1.2k
Avg merge
13h 53m
Merged PRs (30d)
6

Description

We have multiple enquiries regarding the incompatibility between gremlin-python and JanusGraph when using GraphBinary serializer:

https://github.com/JanusGraph/janusgraph/issues/4121
https://github.com/JanusGraph/janusgraph/discussions/4126

We should document that for non-natively supported drivers (everything but java and .Net drivers), users should only use GraphSON serializer but not GraphBinary serializer.

Contributor guide

Open the contributing guide

Research direction

No documentation file is named; first locate the driver and serializer documentation, then read the existing guidance around GraphSON and GraphBinary. Update the relevant documentation to state the serializer limitation for non-natively supported drivers, and verify that the examples and wording distinguish Java and .NET drivers from third-party drivers.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, python
Domain
databases, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.