From 60c5d447267f402d3ad9f070445b73e6ea0d7153 Mon Sep 17 00:00:00 2001 From: joeflack4 Date: Mon, 15 May 2023 19:27:49 -0400 Subject: [PATCH] - Docs: Updated docs/developer/add-new-source.md: Created sub-sections, added some additional information, and updated step 1 info. --- docs/developer/add-new-source.md | 34 +++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/docs/developer/add-new-source.md b/docs/developer/add-new-source.md index 4781756c..5ebb8911 100644 --- a/docs/developer/add-new-source.md +++ b/docs/developer/add-new-source.md @@ -1,6 +1,34 @@ # How to add a new source to the Mondo Ingest +In several of the filename patterns below, `*` represents the ontology name/id. -1. Add a new import and component to [src/ontology/mondo-ingest-odk.yaml](https://github.com/monarch-initiative/mondo-ingest/blob/main/src/ontology/mondo-ingest-odk.yaml). -2. Add a new metadata file to [src/ontology/metadata](https://github.com/monarch-initiative/mondo-ingest/blob/main/src/ontology/metadata). It is important we try and document as much about the source as we can. -3. Update the Website Table of Contents [mkdocs.yaml](https://github.com/monarch-initiative/mondo-ingest/blob/main/mkdocs.yaml) +## 1. `mondo-ingest-odk.yaml` +### 1.1. Add source info +Add a new filename and URL to the `products` > `components` section in [src/ontology/mondo-ingest-odk.yaml](https://github.com/monarch-initiative/mondo-ingest/blob/main/src/ontology/mondo-ingest-odk.yaml). +### 1.2. `update_repo` +From `src/ontology`, run `sh run.sh make update_repo`. + +What this does: This will update several files, including the addition of components goals to src/ontology/Makefile. + +It is possible you may need to run this command twice. The first time will update the update process itself, and the +second time will run the update. + + +## 2. `metadata/*.yaml` +Add a new metadata file to [src/ontology/metadata](https://github.com/monarch-initiative/mondo-ingest/blob/main/src/ontology/metadata). It is important we try and document as much about the source as we can. + +## 3. Docs +### 3.1. `mkdocs.yaml` +Update the Website Table of Contents in [mkdocs.yaml](https://github.com/monarch-initiative/mondo-ingest/blob/main/mkdocs.yaml) + +### 3.2. `docs/sources/*.md` +Run `sh run.sh make ../../docs/sources/*.md` from `src/ontology`. Then edit it manually to add any more informatoin. + +### 3.3. `docs/sources.md` +Add a link to your new `.md` file created in the last step. + +### 3.4. `docs/metrics/*.md` +Run `sh run.sh make ../../docs/metrics/*.md` from `src/ontology`. + +### 3.5. `docs/metrics.md` +Add a link to your new `.md` file created in the last step.