JanusGraph / JanusGraph/janusgraph

Improve JanusGraph Transaction Logs documentation

Open
#3,128 0 comments 1 reaction 0 assignees View on GitHub
area/docs area/logs kind/bug/possible
Dominant language
Java
Stars
5.8k
Forks
1.2k
Avg merge
13h 53m
Merged PRs (30d)
6

Description

Definitions of Transaction Log, Triggers, Trigger Log, Write-Ahead or System Transaction Log, Bus ... in https://docs.janusgraph.org/advanced-topics/transaction-log/ and https://docs.janusgraph.org/advanced-topics/janusgraph-bus/ are confusing.

In particular, the definition of a Trigger Log in the latter seems to match the definition of Transaction Log in the former. And a Transaction Log in the latter seems to refer only to JanusGraph's System/write-ahead transaction log (enabled by `tx.log-tx`). The definition of Triggers in the former is also ambiguous.

We should revisit the janusgraph-bus page, align its terminology with the transaction-log page and potentially merge both pages.

In addition, I think a clear distinction should be made between JanusGraph ("not meant for consumption by the user") transaction log (also mentioned in https://docs.janusgraph.org/operations/recovery/#transaction-failure) and user-defined transaction log.

Contributor guide

Open the contributing guide

Research direction

Start with the transaction-log and janusgraph-bus pages linked in the issue, then compare the transaction-failure recovery page's terminology. Clarify the definitions of Transaction Log, Trigger, Trigger Log, Write-Ahead/System Transaction Log, and Bus, distinguishing JanusGraph's internal log from user-defined logs. Done means the pages use aligned, unambiguous terminology and any needed merge is completed.

Written by the indexing model from the issue text.

Assessment

Domain
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.