Moved ERDs to hsds/serialiaztion.md

openreferral · Oct 25, 2023 · 59afd2d · 59afd2d
1 parent c55a7d1
commit 59afd2d
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 39 deletions.
diff --git a/docs/hsds/overview.md b/docs/hsds/overview.md
@@ -56,42 +56,3 @@ HSDS also defines some special objects which have relationships that fall outsid
 * `attribute` &ndash; see [Attribute](schema_reference.md#attribute). This can be joined to any table other than itself or `metadata` by using its `_link_id` property. It can be linked to `taxonomy_term` using its `taxonomy_term_id` property.
 * `metadata` &ndash; see [Metadata](schema_reference.md#metadata). This can be joined to any table other than itself or `attribute` through its `resource_id` property.
 * `taxonomy_term` &ndash; see [Taxonomy Term](schema_reference.md#taxonomy_term). This can be joined to `taxonomy` using its `taxonomy_id` property.
-
-#### Entity Relationship Diagram
-
-##### Core Objects only
-
-```{eval-rst}
-
-`[enlarge] <../_images/entity_relationship_diagram_core_tables.svg>`_
-
-.. raw:: html
-    :file: ../extras/_images/entity_relationship_diagram_core_tables.svg
-    
-:download:`[download] <../extras/_images/entity_relationship_diagram_core_tables.svg>`
-```
-
-##### Full
-
-<div style="background-color: #77DD77;">
-
-Core objects are shown in green.
-
-</div>
-
-<div style="background-color: #AEC6CF;">
-
-Other objects are shown in blue.
-
-</div>
-
-```{eval-rst}
-
-`[enlarge] <../_images/entity_relationship_diagram.svg>`_
-
-.. raw:: html
-    :file: ../extras/_images/entity_relationship_diagram.svg
-    
-:download:`[download] <../extras/_images/entity_relationship_diagram.svg>`
-
-```
diff --git a/docs/hsds/serialization.md b/docs/hsds/serialization.md
@@ -42,3 +42,44 @@ Instead of dereferencing and embedding objects such as in the canonical JSON ser
 We provide an existing package descriptor generated directly from the canonical HSDS JSON Schema files. It is available [here](../../datapackage.json) and contains details of field names and file names for this serialization. Publishers should use this to support their Tabular Data Package serialization rather than develop their own `datapackage.json` file. Examples CSV files are available in the HSDS Github repo [here](https://github.com/openreferral/specification/tree/3.0/examples/csv).
 
 Prior to HSDS 3.0, Tabular Data Packages were the primary publication format for HSDS data.
+
+### Entity Relationship Diagrams
+
+The following diagrams are generated directly from the [datapackage.json](https://raw.githubusercontent.com/openreferral/specification/3.0/datapackage.json) file. They are representative of the Tabular Data Package serialization of HSDS but not the JSON model.
+
+#### Core Objects only
+
+```{eval-rst}
+
+`[enlarge] <../_images/entity_relationship_diagram_core_tables.svg>`_
+
+.. raw:: html
+    :file: ../extras/_images/entity_relationship_diagram_core_tables.svg
+    
+:download:`[download] <../extras/_images/entity_relationship_diagram_core_tables.svg>`
+```
+
+#### Full
+
+<div style="background-color: #77DD77;">
+
+Core objects are shown in green.
+
+</div>
+
+<div style="background-color: #AEC6CF;">
+
+Other objects are shown in blue.
+
+</div>
+
+```{eval-rst}
+
+`[enlarge] <../_images/entity_relationship_diagram.svg>`_
+
+.. raw:: html
+    :file: ../extras/_images/entity_relationship_diagram.svg
+    
+:download:`[download] <../extras/_images/entity_relationship_diagram.svg>`
+
+```