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

dhis2 update readme #861

Merged
merged 2 commits into from
Dec 10, 2024
Merged

dhis2 update readme #861

merged 2 commits into from
Dec 10, 2024

Conversation

mtuchi
Copy link
Collaborator

@mtuchi mtuchi commented Dec 9, 2024

Summary

Update dead links and restructure the readme to be more developer friendly

Fixes #61

Details

  • Update DHIS2 API docs link
  • Add table of content for easy navigation
  • Add section for unit test and integration test

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to know!):

  • Code generation (copilot but not intellisense)
  • Learning or fact checking
  • Strategy / design
  • Optimisation / refactoring
  • Translation / spellchecking / doc gen
  • Other
  • I have not used AI

You can read more details in our Responsible AI Policy

Review Checklist

Before merging, the reviewer should check the following items:

  • Does the PR do what it claims to do?
  • If this is a new adaptor, added the adaptor on marketing website ?
  • Are there any unit tests?
  • Is there a changeset associated with this PR? Should there be? Note that
    dev only changes don't need a changeset.
  • Have you ticked a box under AI Usage?

@mtuchi mtuchi changed the title update readme dhis2 update readme Dec 9, 2024
@mtuchi mtuchi marked this pull request as ready for review December 9, 2024 19:24
@mtuchi mtuchi requested a review from josephjclark December 9, 2024 19:24
@mtuchi
Copy link
Collaborator Author

mtuchi commented Dec 9, 2024

@josephjclark does this PR need a changeset ?

the main
[Adaptor docs](https://docs.openfn.org/adaptors/packages/dhis2-docs#modules)
page.
This adaptor supports **old tracker versions** and is compatible with DHIS2 API
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh is this right? This is the readme for 6.0.1, which DOES support I think anything from 2.38, but we should say we DON'T support anything earlier

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the important note to include instruction for dhis2 api prior to 2.42

@mtuchi mtuchi requested a review from josephjclark December 10, 2024 12:56
@josephjclark
Copy link
Collaborator

Hey @mtuchi - sorry for the slow review. No changeset needed as there's no public changes!

@josephjclark josephjclark merged commit 78d2064 into main Dec 10, 2024
2 checks passed
@mtuchi mtuchi deleted the 61-dhis2-docs branch December 11, 2024 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

dhis2 Document which DHIS2 adaptor versions are supported by which OpenFn adaptor versions
2 participants