OpenLiberty / OpenLiberty/docs

Reorganise JCache info

Open
#7,662 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

https://openliberty.io/docs/latest/distributed-caching-jcache.html

This container topic is largely about configuration, which should instead be in the feature config reference topic: https://openliberty.io/docs/latest/reference/feature/sessionCache-1.0.html

It is not helpful for this to be the container topic. The Distributed caching topic should be the container topic: https://openliberty.io/docs/latest/distributed-session-caching.html It introduces the concept and gives context to anything else.

The topic about Infinispan starts with a generic shortdesc but it should mention Infinispan and why you might be using that as that's the point of the topic. Nothing in the whole intro section explains why you might choose Infinispan yet the topic assumes you're on OpenShift (which is not necessarily going to be the case). Is Infinispan the only option on OpenShift? Can it be used only on OpenShift? I'm not sure any of this context is given in the 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 comparing the distributed-caching-jcache.html, distributed-session-caching.html, and sessionCache-1.0.html topics to determine where the configuration content belongs. Then review configuring-infinispan-support.html, especially its introduction, for the missing Infinispan purpose and platform context. Done means the topics have the requested structure and the introductory context is clear.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.