-
Notifications
You must be signed in to change notification settings - Fork 3
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.
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
add-new-source.md
updates
#307
Conversation
joeflack4
commented
May 15, 2023
- Docs: Updated docs/developer/add-new-source.md: Created sub-sections, added some additional information, and updated step 1 info.
0a3bdac
to
7dd3a12
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hrsdhgd @souzadevinicius FYI / if you have time to review
|
||
### 1.2. `update_repo` | ||
From `src/ontology`, run `sh run.sh make update_repo`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@matentzn Added this next step about update_repo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.md
as well as adding a link to that file inmkdocs.yaml
as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately ues, mkdocs.yaml is entirely automatically managed. So all of these need to be added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
7dd3a12
to
cf5bbb2
Compare
|
||
### 1.2. `update_repo` | ||
From `src/ontology`, run `sh run.sh make update_repo`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, good!
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately ues, mkdocs.yaml is entirely automatically managed. So all of these need to be added.
LGTM |
67ec741
to
693196c
Compare
…s, added some additional information, and updated step 1 info.
693196c
to
60c5d44
Compare