JanusGraph / JanusGraph/janusgraph

Docs - different perspective

Open
#1,633 2 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

I have been struggling with the docs (partly because I'm not a comp sci grad)

What would make the documentation more useful (or at least make sense of the rest of it) would be a section on usage patterns. For example, Some first time users might like a handheld walkthrough of the steps required to set up a single, stand-alone janusgraph on a personal machine and another (me) might need a remote server to support a small DB and the console on a personal machine, as a test bed to drive a web application to access the data (static queries that are parameterised from web forms) and the obvious other would be an enterprise scale distributed solution.

Each of these would fit better (though not uniquely) with a specific combination of the available component parts. Breaking it down that way gives a realistic target outcome to hang the technology on but also be specific about illustrating the steps and configuration details.

There's so much potential here but the learning curve for us less technical adopters is too high. Please provide a thoughtful, user & outcome centred leg-up.

Thanks
Greg

Contributor guide

Open the contributing guide

Research direction

Review the existing JanusGraph documentation and the available component combinations before defining the scope. Done would include user-centred walkthroughs for a stand-alone personal installation, a remote server with a local console and web application test bed, and an enterprise-scale distributed solution, with setup and configuration details for each.

Written by the indexing model from the issue text.

Assessment

Domain
databases, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.