[DO NOT MERGE] Component doc #2339
Conversation
|
@matentzn would like your eyes on this - wasn't sure how to add general instructions for makefile, not sure if what I wrote is ideal. |
| @@ -0,0 +1,44 @@ | |||
| # Adding components to an ODK repo | |||
|
|
|||
| To add custom components to an ODK repo, please follow the following steps: | |||
There was a problem hiding this comment.
It would be nice to have an introductory section somewhere before this. What is a component in this jargon? When and why would you want to use such components in your ontology?
There was a problem hiding this comment.
have added in docs to do to add an explainer about components
There was a problem hiding this comment.
nvm i see that it is in the docs already
| ``` | ||
| components: | ||
| products: | ||
| - filename: your-component-name.owl |
There was a problem hiding this comment.
Are there any file naming conventions that we should follow here?
There was a problem hiding this comment.
not sure on this - @matentzn?
docs/add-components.md
Outdated
| Import(<http://purl.obolibrary.org/obo/uberon/components/your-component-name.owl>) | ||
| ``` | ||
| 5. Refresh your repo by running `sh run.sh make update_repo` - this should create a new file in src/ontology/components. | ||
| 6. In your custom makefile (src/ontology/uberon.Makefile) add a goal for your custom make file as follows: |
There was a problem hiding this comment.
Is this part needed when adding a component that uses a ROBOT template?
There was a problem hiding this comment.
you need to add a goal, but the goal would the robot template - will make this more clear. Thanks :)
|
moved to ODK jinja docs INCATools/ontology-development-kit#577 |
Docs for component
Adding it as a draft PR for UBERON for now, will generalise it in jinja once @rays22 gives feedback