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

Adding import documentation #1405

Merged
2 commits merged into from
Jan 14, 2022
Merged

Adding import documentation #1405

2 commits merged into from
Jan 14, 2022

Conversation

ghost
Copy link

@ghost ghost commented Jan 14, 2022

Adding brief documentation on what to do if one needs to add a class/term to CL that has not yet been imported from another ontology

@ghost ghost self-assigned this Jan 14, 2022
@ghost ghost requested a review from shawntanzk January 14, 2022 11:19
@ghost ghost linked an issue Jan 14, 2022 that may be closed by this pull request
@ghost
Copy link
Author

ghost commented Jan 14, 2022

Thank you very much for the feedback so far, @shawntanzk!

@dosumis
Copy link
Contributor

dosumis commented Jan 14, 2022

Looks good. @shawntanzk - does this method no longer work? https://obophenotype.github.io/cell-ontology/odk-workflows/UpdateImports/#using-term-files

Addition in Protege has a couple of minor drawbacks:

  • it adds to declarations in the editor's file (occasionally a cause or problems, e.g. declarations may need to be deleted if terms are no longer used.)
  • prior to import it causes failure of the SPARQL label and def checks (or at least it used to) - I think this is connected to the presence of declarations.

I don't think this is a blocker though. Maybe worth discussion in a future tech call.

@shawntanzk
Copy link
Contributor

does this method no longer work? https://obophenotype.github.io/cell-ontology/odk-workflows/UpdateImports/#using-term-files

unfortunately not for merged/base file import, from my understanding, it does not use the separate import files anymore.

I will add the concerns for the tech call and get back to you on them.

@gouttegd I can't remember exactly what it is, but do we need to index the docs somewhere? also do we need to run a make the docs or something? I vaguely remember something about that but its been awhile since I've edited the docs. Thanks!

@gouttegd
Copy link
Collaborator

I can't remember exactly what it is, but do we need to index the docs somewhere?

Not that I am aware of. Please note, however, that the entire obophenotype.github.io website hosting the documentation has been set up long before I joined the party, and I was never involved with it. So I may not be aware of everything. :)

also do we need to run a make the docs or something?

There’s a GitHub Action in place to do that automatically. It doesn’t work in the ODK repository (I am testing a workaround for that right now), but in CL it should work as expected.

@shawntanzk
Copy link
Contributor

There’s a GitHub Action in place to do that automatically.

omg the quality of life improvement on this is amazing! think you were the one who implemented this right? if so thanks so much!

@gouttegd
Copy link
Collaborator

think you were the one who implemented this right?

Nope. :) I implemented the actions to automatically build, test, and release the ODK.

I believe the actions to automatically build the docs were added by Nico.

@ghost ghost merged commit 6b4ec41 into master Jan 14, 2022
@ghost ghost deleted the adding-import-documentation branch January 14, 2022 14:01
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation on importing classes to CL
3 participants