JanusGraph/janusgraph

Adding a dedicated operation section into our docs

Open

#1,823 opened on Oct 6, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4,985 stars) (1,137 forks)batch import
area/docshelp wantedkind/enhancement

Description

It would good to have dedicated section in our docs for running JanusGraph in production.

Including

After, we have a better getting started section, we could include also deployment scenarios, such as, kubernetes, docker, or site by site deployments (backends and JanusGraph on the same machine).

Contributor guide

Tech stack
javaprometheusgrafanadockerkubernetes
Domain
documentationdevops
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of JanusGraphUnderstanding of monitoring tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Create a new section in the JanusGraph documentation under the 'Operations' chapter. Research existing monitoring setups using Prometheus and Grafana, tuning parameters from external resources, and common operational issues. Include deployment scenarios like Docker and Kubernetes, referencing the official JanusGraph deployment guides. The new section should be structured with subheadings for each topic.