OpenLiberty / OpenLiberty/docs
Investigate if more is needed about concurrency
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 14
- Forks
- 58
- Avg merge
- 4m
- Merged PRs (30d)
- 35
Description
From KC review (so check with SME or Alasdair).
In the OL docs, we have an introduction to concurrency on Open Liberty using Java SE, Java/Jakarta EE, and MicroProfile.
Do we need:
- More doc about how to do concurrency? Or is the bulkhead guide sufficient for showing best practice examples? (we don't want to duplicate the guide info if it's sufficient, but if there's more that microservices/cloud-native developers would need to know to be able to use concurrency effectively, we should look at adding that to the OL docs). Also not trying to cover every eventuality, but we do need people to be able to use it.
- In the KC, there are the following topics about configuring Java EE concurrency - is this what we'd consider best practice now? Or is most of it autonomous and/or covered by using MIcroProfile Context Propagation (as described in the existing OL docs topic and the bulkhead guide) now?
- https://www.ibm.com/support/knowledgecenter/SSAW57_liberty/com.ibm.websphere.wlp.nd.multiplatform.doc/ae/twlp_config_managedexecutor.html
- https://www.ibm.com/support/knowledgecenter/SSAW57_liberty/com.ibm.websphere.wlp.nd.multiplatform.doc/ae/twlp_config_scheduledexecutor.html
- https://www.ibm.com/support/knowledgecenter/SSAW57_liberty/com.ibm.websphere.wlp.nd.multiplatform.doc/ae/twlp_config_contextservice.html
- https://www.ibm.com/support/knowledgecenter/SSAW57_liberty/com.ibm.websphere.wlp.nd.multiplatform.doc/ae/twlp_config_threadfactory.html
- Are there commonly needed server configurations that should be added to Java EE Concurrency Utilities feature doc and/or MicroProfile Context Propagation feature? Only add if they're useful to most target users and/or they're something we'd like users to be doing.
- Don't document all the properties as they're already documented in the generated config docs (see the links in the two feature docs).
SME: Nathan Rauh @njr-11
Contributor 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.
Research direction
Start by reviewing the existing concurrency topic, bulkhead guide, and the Java EE Concurrency Utilities and MicroProfile Context Propagation feature docs linked in the issue. Consult the named SME or Alasdair before deciding whether the KC topics reflect current best practice. Done means documenting the agreed gaps or recording that no further documentation is needed, without duplicating generated configuration details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100