Skip to content
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

Updated import docs #519

Merged
merged 3 commits into from
Feb 4, 2022
Merged

Updated import docs #519

merged 3 commits into from
Feb 4, 2022

Conversation

shawntanzk
Copy link
Contributor

See #514 (comment)

Sorry about that @bvarner-ebi & @dosumis - my bad for misunderstanding the import system. Fixed the docs accordingly here.

Copy link
Contributor

@gouttegd gouttegd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me except for the duplicated lines around 1082–1084.

Comment on lines 1086 to 1088
To check if your ontology uses this method, check src/ontology/{{ project.id }}-odk.yaml to see if `use_base_merging: TRUE` is declared under `import_group`

1. Open your ontology (edit file) in Protege (5.5+).
1. Select 'owl:Thing'
1. Add a new class as usual.
1. Paste the _full iri_ in the 'Name:' field, for example, http://purl.obolibrary.org/obo/CHEBI_50906.
1. Click 'OK'
If your ontology uses Base Module approach, please use the following steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 1086–1088 are duplicate of lines 1082–1084.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoops, my bad, i accidentally commited on a dirty branch, and was moving things around and missed that. Thanks for spotting :)

@matentzn
Copy link
Contributor

matentzn commented Feb 4, 2022

I am not sure why the instruction for the Protege based approach are removed entirely.. How should people work without access to docker/odk? Are these instructions going somewhere else?

@shawntanzk
Copy link
Contributor Author

I am not sure why the instruction for the Protege based approach are removed entirely.. How should people work without access to docker/odk? Are these instructions going somewhere else?

ok looking at the diff for this, something looks odd -let me go relook at the whole thing again and redo this properly. (there was some removal cause there was duplicated things, but it seems that it ended up fully removing it. Sorry about that will fix

@shawntanzk
Copy link
Contributor Author

@matentzn ok looked at the whole docs, the protege-based declaration is still up top, however I removed it from the base file approach after recommendation that that is not great a way. With base file approach, ODK is kinda needed anyway no? (eg if someone is adding using the protege-based declaration, they have the instructions up top, but if someone is working with base-file, they would not need to do with protege-based declaration.)
Happy to add back the protege-based declaration to the base-file section if you think its useful there too

@matentzn
Copy link
Contributor

matentzn commented Feb 4, 2022

Regardless of base or anything else, adding a term can be done using Protege if necessary, even if that is discouraged. In order to actual run the import (import the term, not just declare it (step1)), you need ODK in both cases!

@shawntanzk
Copy link
Contributor Author

Regardless of base or anything else, adding a term can be done using Protege if necessary

This step is already present in ln949 - should I copy and paste it somewhere around 1084?

@matentzn
Copy link
Contributor

matentzn commented Feb 4, 2022

No, if its clear that it applies to all approaches, then no need for duplication

@shawntanzk
Copy link
Contributor Author

I'll make sure it is :)

@shawntanzk shawntanzk requested a review from gouttegd February 4, 2022 10:56
@shawntanzk
Copy link
Contributor Author

ready to go - will merge after a thumbs up

@shawntanzk shawntanzk merged commit d4ae608 into master Feb 4, 2022
@shawntanzk shawntanzk deleted the import-docs branch February 4, 2022 13:06
@matentzn matentzn added this to the 1.2.33 milestone Feb 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants