-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #307 from monarch-initiative/docs-new-sources
`add-new-source.md` updates
- Loading branch information
Showing
1 changed file
with
31 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |