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.

Sign up for GitHub

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

Jump to bottom

Update schema diagram/description in documentation #2694

Closed
punktilious opened this issue Aug 17, 2021 · 4 comments
Closed

Update schema diagram/description in documentation #2694

punktilious opened this issue Aug 17, 2021 · 4 comments
Assignees
@punktilious
Labels
P2 Priority 2 - Should Have technical debt

Comments

@punktilious
Copy link
Collaborator

The schema documentation has fallen behind the current implementation. Update the diagram and document the new tables.
@lmsurpre lmsurpre added the P2 Priority 2 - Should Have label Oct 11, 2021
@lmsurpre
Copy link
Member

  1. Update the existing docs at https://github.com/IBM/FHIR/blob/main/fhir-persistence-schema/docs
  2. Introduce a new doc on our schema design with an accurate picture..maybe just an update to https://github.com/IBM/FHIR/blob/main/fhir-persistence-schema/docs/mt-table.png ?

@lmsurpre
Copy link
Member

Focus on db2 and postgresql (not derby)

@punktilious punktilious self-assigned this Jan 18, 2022
punktilious added a commit that referenced this issue Jan 19, 2022
@punktilious
issue #2694 refreshed and refactored schema design documentation
332f11f 
Signed-off-by: Robin Arnold <robin.arnold@ibm.com>
punktilious added a commit that referenced this issue Jan 19, 2022
@punktilious
issue #2694 updated schema docs merged with main
6ea86ae 
Signed-off-by: Robin Arnold <robin.arnold@ibm.com>
punktilious added a commit that referenced this issue Jan 28, 2022
@punktilious
issue #2694 addressed review comments. Fixed links pointing to old ma…
126bad3 
…ster branch

Signed-off-by: Robin Arnold <robin.arnold@ibm.com>
punktilious added a commit that referenced this issue Jan 28, 2022
@punktilious
issue #2694 fixed outdated search param table list
3460066 
Signed-off-by: Robin Arnold <robin.arnold@ibm.com>
lmsurpre pushed a commit that referenced this issue Jan 31, 2022
@punktilious
Issue 2694 update schema design docs (#3215)
e1b68bf 
* issue #2694 refreshed and refactored schema design documentation

Signed-off-by: Robin Arnold <robin.arnold@ibm.com>

* issue #2694 addressed review comments. Fixed links pointing to old master branch

Signed-off-by: Robin Arnold <robin.arnold@ibm.com>

* issue #2694 fixed outdated search param table list

Signed-off-by: Robin Arnold <robin.arnold@ibm.com>
@lmsurpre
Copy link
Member

For QA:

  1. try following the sample commands in the tl;dr version at https://github.com/IBM/FHIR/tree/main/fhir-persistence-schema#tldr

  2. follow links and confirm any expected information is present / arranged reasonably at https://github.com/IBM/FHIR/blob/main/fhir-persistence-schema/docs/SchemaToolUsageGuide.md

@d0roppe
Copy link
Collaborator

d0roppe commented Jan 31, 2022

read through the documentation and checked the links. Working as expected. Closing issue.

@d0roppe d0roppe closed this as completed Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@punktilious punktilious

Labels
P2 Priority 2 - Should Have technical debt
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lmsurpre @punktilious @d0roppe