JanusGraph / JanusGraph/janusgraph

Deferred docs cleanup

Open
#149 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

This issue will catalog the deferred cleanup tasks identified during the review of PR #115.

- [ ] `docs/basics.txt`: "We already differentiate between LOCAL and REMOTE deployments. And refer to BerkeleyJE as an embedded persistence engine. Somewhere I also think I saw "embedded Cassandra" in Janus. Shall we call this "serverless" or "headless" mode to avoid confusion with other uses of the word embedded?" – @amcp
- [ ] `docs/basics.txt`: rationalize the uses of the term "server", "cluster", "instance".
* @amcp [said](https://github.com/JanusGraph/janusgraph/pull/115#discussion_r101560594): Replace _"A JanusGraph graph database cluster consists of one or multiple JanusGraph instances."_ with _"JanusGraph server cluster consists of one or more JanusGraph server instances."_
* @jerryjch [said](https://github.com/JanusGraph/janusgraph/pull/115#discussion_r104328235): "Will the use of term 'server' cluster confuse with the real Gremlin JanusGraph server? Implying that there are always Gremlin server involved (the so-called remote server mode) and excluding other deployment modes?"
- [ ] `docs/bulkloading`: "Batchgraph is TP2.0 concept. Now i think we have BulkVertexLoaderProgram or something like that." – @amcp
- [ ] `docs/bulkloading.txt`: same for Data Sorting as for Batchgraph
- [ ] `docs/hbase.txt`: add instructions for EMR + HBase
- [ ] `docs/partitioning.txt`: "Edge cuts are more meaningful when the JanusGraph servers are on the same hosts as the storage backend. If you have to make a network call to a different host on each hop of a traversal, the benefit of edge cuts and custom placement strategies can be largely nullified." – @amcp

Contributor guide

Open the contributing guide

Research direction

Start by reviewing PR #115 and its discussion, then inspect the checklist locations in docs/basics.txt, docs/bulkloading, docs/bulkloading.txt, docs/hbase.txt, and docs/partitioning.txt. Resolve the terminology, bulk-loading, EMR/HBase, and partitioning guidance issues described there, with every checklist item addressed in the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, cassandra
Domain
databases, 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.