SDK: Research and Document Compatibility Between dotCMS LTS and SDK Versions
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 970
- Forks
- 486
- Avg merge
- 3d 33m
- Merged PRs (30d)
- 170
Description
Problem Statement
Currently, there is no documented compatibility table that maps dotCMS LTS versions to compatible SDK versions. This creates challenges for partners and customers when upgrading dotCMS, as they lack a clear reference for which SDK version they should use.
Task
We should provide a compatibility table in our dev site, such as:
| dotCMS TLS | SDK |
|---|---|
| dotCMS LTS v10.02.25 | SDK alpha v58-68 |
| dotCMS LTS v10.03.25 | with SDK alpha v70 or newer |
This table would help partners efficiently update client projects with a clear reference of which SDK version they should use for their dotCMS instance.
Proposed Objective
Technical User Experience
Proposed Priority
Priority 3 - Average
Acceptance Criteria
- [ ] Research and document the compatibility between dotCMS LTS versions and SDK versions.
- [ ] Add a comment in this ticket with a table listing compatible versions.
- [ ] Create a documentation page for this in https://dev.dotcms.com/
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 researching the compatibility between dotCMS LTS versions and SDK versions, then record the findings in the issue comment using the proposed table format. Create a documentation page on https://dev.dotcms.com/ and ensure it provides a clear mapping that helps partners select an SDK for each dotCMS LTS version.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100