Troubleshooting docs
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
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.
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.
- Dominant language
- No language data
- Stars
- 14
- Forks
- 58
- Avg merge
- 1h 4m
- Merged PRs (30d)
- 21
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from OpenLiberty/docs
-
source mismatchOpen
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
OpenLiberty/docs#8579 ·
Maintainers usually reply within 1 day
-
Jandex extended pathOpen
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
OpenLiberty/docs#8451 · 1 comment ·
Maintainers usually reply within 1 day
-
CVE update for 26.0.0.10Possibly taken @ramkumar-k-9286 claimed this 19 days ago. Open26.0.0.10 Developer reviewed
OpenLiberty/docs#8563 · 5 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
26.0.0.11
Difficulty 5/5 Over a week Newbie friendliness 25/100
OpenLiberty/docs#8548 ·
Maintainers usually reply within 1 day
-
26.0.0.12
Difficulty 4/5 3-5 days Newbie friendliness 45/100
OpenLiberty/docs#8529 · 1 comment ·
Maintainers usually reply within 1 day
All issues in OpenLiberty/docs
Similar issues
-
Lists nested four or more levels deep have no left marginPossibly taken @tpavlic claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
josephwright/ltx-talk#292 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
apache/rocketmq-dashboard#7248 ·
Maintainers usually reply within 3 days
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
4.4 Project/Configuration
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
qgis/QGIS-Documentation#11337 · 1 comment ·
Maintainers usually reply within 2 days
-
[BUG] Still libmicrohttpd dependency is not removed properly from External-Dependency-Info.txt fileOpentype/bug
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Maintainers usually reply within 1 day