OpenLiberty / OpenLiberty/docs

Troubleshooting docs

Open
#3,331 3 comments 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 troubleshooting docs.

Notes from discussion with Alasdair:

Troubleshooting docs should take the approach of: "I'm doing x and getting this error. The solution is y." rather than just listing "limitations" or things that someone is just expected to remember. Troubleshooting docs, to be useful, need to be in a framing than enables the user to search/browse for something that describes the unfortunate situation that they're currently in. Then take their hand and make it all better. :)

The difference between troubleshooting and operations docs:

  • Troubleshooting Liberty is the kind of thing in this topic where you get a message and here's what to do about it.
  • Whereas, not analytics, logging, etc that we'd put in Operations.

Talk to L2 and L3:

  • Some of the tech docs online are troubleshooting "if you see x, then you need to do y".
  • talk to L2 and L3 to work out if there's things that we haven't covered that should be here

When prioritising troubleshooting work, follow the priority order of the functional areas of topics we've already got, in general.

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 troubleshooting topics and their functional-area priority order, then consult L2 and L3 for missing scenarios. Done means the relevant gaps are identified and troubleshooting guidance is updated around user symptoms, error messages, and concrete solutions rather than general limitations.

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.