OpenLiberty / OpenLiberty/docs

Service topic

Open
#2,664 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

@cbridgha proposed having a service page that includes things like "how to create a dump, setup tracing etc.. Any must gather info... we don't "support" OL, but we can provide tips for investigating issues?" That's not an exhaustive list. Let's work on an outline of this first to see what info we'd want in it and get feedback on the outline before moving forward with writing anything on this topic.

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 outlining the proposed service page around the example topics of dump creation, tracing setup, and investigation tips. Share the outline for feedback before writing the documentation; done means an agreed outline that defines the information the page should cover.

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.