add-new-source.md updates
#307
Conversation
joeflack4
commented
May 15, 2023
joeflack4
commented
- Docs: Updated docs/developer/add-new-source.md: Created sub-sections, added some additional information, and updated step 1 info.
joeflack4
force-pushed
the
docs-new-sources
branch
from
0a3bdac
to
7dd3a12
Compare
|
|
||
| ### 1.2. `update_repo` | ||
| From `src/ontology`, run `sh run.sh make update_repo`. |
There was a problem hiding this comment.
@matentzn Added this next step about update_repo
There was a problem hiding this comment.
I added a note about it needing to run twice as well. However, as I mentioned in this comment, running it a second time did not seem to do anything for me.
docs/developer/add-new-source.md
Outdated
| ## 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. `mkdocs.yaml` |
There was a problem hiding this comment.
@matentzn Do you think something is missing here? I noticed that it looks like I manually needed to add links to gard.md in several places. It doesn't look like mkdocs build is what I want to run. Perhaps we need to write something here about manually making some other additions? Such as:
sources/ONTOLOGY.md- Adding ONTOLOGY to
sources.md - What about
metrics/ONTOLOGY.mdas well as adding a link to that file inmkdocs.yamlas well?
There was a problem hiding this comment.
Unfortunately ues, mkdocs.yaml is entirely automatically managed. So all of these need to be added.
There was a problem hiding this comment.
Np. I added instructions for adding these. I see now that there are some goals that help with these:
../../docs/sources/%.md
../../docs/metrics/%.md
joeflack4
force-pushed
the
docs-new-sources
branch
from
7dd3a12
to
cf5bbb2
Compare
|
|
||
| ### 1.2. `update_repo` | ||
| From `src/ontology`, run `sh run.sh make update_repo`. |
docs/developer/add-new-source.md
Outdated
| ## 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. `mkdocs.yaml` |
There was a problem hiding this comment.
Unfortunately ues, mkdocs.yaml is entirely automatically managed. So all of these need to be added.
LGTM |
joeflack4
force-pushed
the
docs-new-sources
branch
4 times, most recently
from
67ec741
to
693196c
Compare
…s, added some additional information, and updated step 1 info.
joeflack4
force-pushed
the
docs-new-sources
branch
from
693196c
to
60c5d44
Compare
