OpenLiberty / OpenLiberty/docs

Fault tolerance docs

Open
#3,293 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

epic
Dominant language
No language data
Stars
14
Forks
58
Avg merge
4m
Merged PRs (30d)
35

Description

This epic is to track updates and doc bugs across the fault tolerance docs.

Notes from a conversation with Andrew Rouse about things that would be helpful to include in the fault tolerance docs:

  • The location of the javadoc and spec (the spec's job generally is to describe how the implementation must behave, and users' questions usually boil down to "how does the implementation behave when I do this?" or "why is the implementation doing this when I do that?" or "how do I make it do something else")
  • Maybe a couple more examples
  • The execution flow diagrams
  • The event tracing
  • A list of common pitfalls

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing fault tolerance documentation and the listed notes. Identify the relevant Javadoc and specification locations, then determine which examples, execution-flow diagrams, event tracing details, and common pitfalls are missing. Done means the fault tolerance documentation has been updated to cover the agreed scope.

Written by the indexing model from the issue text.

Assessment

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