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

Documentation on Gateway Plugins implementation #24

Open
ndegwamartin opened this issue Nov 22, 2023 · 1 comment
Open

Documentation on Gateway Plugins implementation #24

ndegwamartin opened this issue Nov 22, 2023 · 1 comment
Assignees

Comments

@ndegwamartin
Copy link
Collaborator

We need some documentation on some of our technical implementation so that we can have an external reference for conversations with other stakeholders e.g. Clients, Google as well as help onboarding new engineers.

We need to document.

  1. The way + why(challenges) we use it with the fhir-gateway as not as an external plugin as documented on the parent repo README but rather bundled the gateway as a library dependency (for the plugin). Mention also that a direct implication of this is that anytime one needs to use the latest HAPI FHIR Server, they would need a new release of the FHIR Gateway Plugins artifact.

  2. The set up instructions for the gateway for external teams e.g. Download the image from our Dockerhub repo here https://hub.docker.com/r/onaio/fhir-gateway-plugin/tags and just run that.

  3. Differences on how we access custom and non custom endpoints. You can copy from some of your new documentation here PR 19

Ideally, you need to document these on the FHIR Core docs here under Engineering (Create a new Backend section) https://docs.opensrp.io/ however a Google doc should be okay as well if short of time.

@rehammuzzamil
Copy link
Contributor

Here is the documentation. For the complete documentation, readme.md has all the details. @ndegwamartin @dubdabasoduba

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants