OpenLiberty / OpenLiberty/docs

ID: APSFOUND-73: open-liberty documentation

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

Nobody has claimed this yet.

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

Description

Does the documentation apply to all platforms?
  • Yes
  • No. Specific platforms: ______
Does the documentation apply to all editions

(Liberty Core, Liberty base, Liberty ND, Liberty z/OS)?

  • Yes.
  • No. Specific editions: ______
Specify what you want documented (required):

For each new topic, complete the following information:

To create a topic:
To update to an existing topic:
  • Include a copy of the current text and the exact text to which it will change. For example: Change ABC to XYZ:
  • Specify a link to the topics that are affected:
To add a custom property, complete the following checklist:
  • Specify a link to the topic that will contain the custom property:
  • The name and a description of the custom property
  • Default values and other values
  • Behavior of the values

Draft

The feature APSFOUND-73 for Liberty (https://github.com/OpenLiberty/open-liberty/issues/7918) basically implements the following information from tWAS documentation:

https://www.ibm.com/support/knowledgecenter/SSEQTP_9.0.5/com.ibm.websphere.base.doc/ae/cejb_bindingsejbfp.html

So, the link above from tWAS should be used as the starting point for nearly identical documenation for liberty linked off the following Liberty doc : https://www.ibm.com/support/knowledgecenter/SSEQTP_liberty/com.ibm.websphere.wlp.doc/ae/twlp_ejb_dev.html

The following changes should be made to the tWAS version of the doc for Liberty:

Remove 1st sentence of 2nd paragraph:

Starting in Version 8.0, bindings support in the EJB container is expanded.

Remove the entire section with the following heading:

Naming considerations in clustered and cross-server environments

Remove the information about :

Extensions defined in META-INF/ibm-ejb-jar-ext-pme.xml file

i.e. includes the removal of Table 8.

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

Compare the linked tWAS topic with the Liberty navigation target, using the APSFOUND-73 implementation issue for context. Adapt the draft for Liberty while applying the three listed removals, then verify that the new topic is linked from the specified EJB development documentation section.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.