OpenLiberty / OpenLiberty/docs
The Open Liberty version in which features were introduced into Open Liberty
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 14
- Forks
- 58
- Avg merge
- 4m
- Merged PRs (30d)
- 35
Description
Observed problem:
Graham:
I sometimes get asked [by Liberty support customers or by IBMers] when a feature went into OL, and the Liberty Repository info on the right really helps with that.
The Liberty Repository currently displays this info on each feature's page:
Graham:
the 'from' release is most useful [as in the KC, rather than the date as shown in the Liberty Repo].
Also, the Java SE version compatibility info (as shown in the Liberty Repo) could be considered for inclusion too.
Graham:
SE versions has been useful in the past and may continue to be. For example historically some EE feature would only work on a later Java. Jakarta EE 10, for example, might mandate Java 11, but we would still be supporting Java 8 with older features.
Possible solutions
Two solutions I could think of. I think enhancing the generated feature docs rather than creating a separate doc topic would be better. Would consolidate all info about a given feature in a predictable single place.
Would need to talk to Chuck/Michal/Alasdair
Solution 1. Enhance generated feature doc to include such info
We could insert that info into the generated feature docs, either during the initial generation or using includes (but would need to be automated so that it could be maintained).
Would need to talk to Chuck/Michal/Alasdair.
Solution 2. Create a separate reference topic for OL docs
Consider a reference topic that's a greatly simplified version of this KC topic: https://www.ibm.com/support/knowledgecenter/SSEQTP_liberty/com.ibm.websphere.wlp.doc/ae/rwlp_feat.html
- Open Liberty versions only - none of the WebSphere stuff
- Starting from the first OL version (17.0.0.3) - anything earlier is 17.0.0.3 because OL didn't exist before that.
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 generated feature documentation approach and the linked Knowledge Center feature reference. Confirm with Chuck, Michal, and Alasdair whether the docs should include each feature's Open Liberty introduction release and Java SE compatibility, or use a separate reference topic. Done means the chosen approach is agreed and the information is maintained automatically.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100