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

Render Mappings section generally on all element documentation pages #2087

Merged
merged 4 commits into from
Dec 4, 2024

Conversation

sujaypatil96
Copy link
Collaborator

Analogous to linkml/linkml#2172

Copy link

github-actions bot commented Jun 25, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://microbiomedata.github.io/nmdc-schema/pr-preview/pr-2087/
on branch gh-pages at 2024-10-16 22:23 UTC

@sujaypatil96 sujaypatil96 marked this pull request as draft June 25, 2024 20:20
@sujaypatil96
Copy link
Collaborator Author

Converting this PR to draft because the GitHub Action workflow needs to be fixed in linkml-project-cookiecutter and then the changes need to be applied here: https://github.com/linkml/linkml-project-cookiecutter/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/.github/workflows/test_pages_build.yaml to keep both of them in sync

@sujaypatil96 sujaypatil96 marked this pull request as ready for review July 11, 2024 16:54
@sujaypatil96 sujaypatil96 requested a review from turbomam July 11, 2024 18:18
Copy link
Member

@turbomam turbomam left a comment

Choose a reason for hiding this comment

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

doesn't change schema but does improve understand-ability of the schema through the documentation. I recommend merging into both schema now.

@sujaypatil96
Copy link
Collaborator Author

This PR is ready to be approved and merged.

See these two pages for example:

@turbomam
Copy link
Member

@turbomam
Copy link
Member

@sujaypatil96
Copy link
Collaborator Author

sujaypatil96 commented Oct 16, 2024

@turbomam the above links are working again.

Screenshot 2024-10-16 at 3 28 19 PM

What I did was to re-trigger the PR preview GitHub Action workflow/run on this PR again: https://github.com/microbiomedata/nmdc-schema/actions/runs/11350934707/job/31644169923

However, if this PR preview Action is running on other PRs then I believe it might overwrite this one, and it will preserve whatever is latest so it can avoid "overpopulating" the gh-pages branch.

@sujaypatil96 sujaypatil96 requested a review from turbomam October 16, 2024 22:30
@turbomam
Copy link
Member

great, I see them now.

What's the value of the self and native mappings?

What does objective's SIO mapping show up as undefined?

@sujaypatil96
Copy link
Collaborator Author

sujaypatil96 commented Oct 24, 2024

I'm not entirely sure 🤔 I can look through some documentation and try to see if I can understand what self and native signify exactly, but here is the schemaview method that is responsible for what is rendered in the Mappings section: https://github.com/linkml/linkml-runtime/blob/main/linkml_runtime/utils/schemaview.py#L1171-L1199

@turbomam
Copy link
Member

turbomam commented Dec 3, 2024

Let's talk about this again soon. I wrote some code to dump all mappings in the schema, so that gave me a chance to review concepts like native, self and undefined.

My goal is to emphasize the most useful parts of the mappings and omit the things that are obvious, can be taken for granted, etc. I think the self and native mappings are usually not very enlightening, especially if they are the same, and/or if they are equivalent to the default prefix + the element name.

I think i prefer the term "unqualified" or just "mappings" over "undefined", but we shouldn't go by my personal preference alone.

Copy link
Member

@turbomam turbomam left a comment

Choose a reason for hiding this comment

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

@turbomam turbomam merged commit 4da2595 into main Dec 4, 2024
3 checks passed
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.

2 participants