JanusGraph / JanusGraph/janusgraph
Adding a dedicated operation section into our docs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 5.8k
- Forks
- 1.2k
- Avg merge
- 13h 53m
- Merged PRs (30d)
- 6
Description
It would good to have dedicated section in our docs for running JanusGraph in production.
Including
* Monitoring for example how setup a prometheus exporter for JanusGraph (dashboards)
* Tuning for example (https://www.experoinc.com/post/janusgraph-nuts-and-bolts-part-1-write-performance)
* Common Problems
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing getting started section and the production-operation topics named in the issue. Add a dedicated section covering monitoring with Prometheus exporters and dashboards, tuning, common problems, and deployment scenarios such as Kubernetes, Docker, and site-by-site deployments. Done means these operational topics are documented in a cohesive production guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, kubernetes, prometheus
- Domain
- devops, documentation, observability
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100