Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDK: Improve JS Client Readme #30614

Open
zJaaal opened this issue Nov 8, 2024 · 1 comment · Fixed by #30677
Open

SDK: Improve JS Client Readme #30614

zJaaal opened this issue Nov 8, 2024 · 1 comment · Fixed by #30677

Comments

@zJaaal
Copy link
Contributor

zJaaal commented Nov 8, 2024

Task

Right now the JS SDK client readme is covering installation of the SDK, configuration and basic use cases. But we need to add examples for basic use cases of the content API.

The content API just have one method at the moment, which is the getCollection but it is a method that uses a builder pattern to create complex queries, so we require basic use cases so the developers can have a simple guide of how it works.

We can see which methods it has and write use cases for them

Proposed Objective

Technical User Experience

Proposed Priority

Priority 3 - Average

Acceptance Criteria

  • SDK JS Client Readme has all basic cases covered for the content API.
  • Writing should be clear and easy to understand with basic knowledge on the API.
  • Be sure that the methods have no missing docs or examples.

Assumptions & Initiation Needs

  • You understand how the content API works in the SDK JS Client
@zJaaal zJaaal moved this from New to Next 1-3 Sprints in dotCMS - Product Planning Nov 8, 2024
@zJaaal zJaaal removed the Triage label Nov 8, 2024
@nollymar nollymar moved this from Next 1-3 Sprints to Gardening Day Backlog in dotCMS - Product Planning Nov 8, 2024
@rjvelazco rjvelazco self-assigned this Nov 15, 2024
@rjvelazco rjvelazco moved this from Gardening Day Backlog to In Progress in dotCMS - Product Planning Nov 15, 2024
@rjvelazco rjvelazco linked a pull request Nov 15, 2024 that will close this issue
Copy link

@github-project-automation github-project-automation bot moved this from In Progress to Internal QA in dotCMS - Product Planning Nov 15, 2024
@rjvelazco rjvelazco removed their assignment Nov 18, 2024
@rjvelazco rjvelazco reopened this Nov 18, 2024
@github-project-automation github-project-automation bot moved this from Internal QA to Current Sprint Backlog in dotCMS - Product Planning Nov 18, 2024
@rjvelazco rjvelazco moved this from Current Sprint Backlog to Internal QA in dotCMS - Product Planning Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Internal QA
Development

Successfully merging a pull request may close this issue.

3 participants