OpenLiberty / OpenLiberty/docs

Suggested topic area: JCA (standardised connectors/adapters to resources)

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

Nobody has claimed this yet.

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

Description

From KC review (so check with Alasdair).

It might be that mostly what's needed is just config examples in the JCA feature doc but as we don't have anything (I think) on JCA yet, it might need something more like an introductory topic at least?

Having taken a look at the JCA topics in the KC:

Those topics are mainly pages and pages of config examples that aren't very interesting or informative to read. It would be more useful I think maybe to write a topic that provides an introduction to what JCA is and why you might choose to use it (otherwise, there's no point reading on). Then, in the JCA feature topic maybe provide some really common, useful simple config examples and link to them from the intro topic. Then in the intro topic, maybe provide some other config examples (maybe slightly longer examples? but not too complicated to follow) and explain what those configurations would do and why you'd do it that way (don't just describe what the attribute and element values are because that's obvious from looking at the example). Don't provide the examples broken down into step-by-step procedures - that's not helpful for configuration.

But start by talking to an SME and asking them what it is and why a developer would use it in a containerised app (it must be in the contains/cloud deployment context). Then find out what the most important things are for the developer to know how to do in order to be able to use it (not all information is equal in value - don't include everything for the sake of it).

This, or some parts, probably have a dependency on #3313 (JMS messaging) because some of it will probably be about connecting to JMS messaging resources.

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 with the JCA feature document and the linked Knowledge Center topics, then consult an SME about JCA and its use in containerised applications. Review the dependency on issue #3313 and identify the most valuable introductory guidance and configuration examples. Done means a focused JCA introduction with useful examples linked from the feature topic, rather than a broad collection of reference material.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.