-
Notifications
You must be signed in to change notification settings - Fork 0
Add FAIR Guide with Checklists #37
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
base: main
Are you sure you want to change the base?
Conversation
As written for AI and Ecology Course 2025 Co-authored-by: Net Zhang <zhang.11091@osu.edu>
link to relevant lines of templates and specific section of GH guide
retain filename for consistency of links
keep consistent with other pages in section
include all checklists and new FAIR page in navigation renames Metadata Guide Page as Metadata Checklist for navigation bar
… other checklists Adjust descriptions when referencing it accordingly
…patibility This seems to be related to [this issue](mkdocs/mkdocs#545), [this issue](Python-Markdown/markdown#3) and [this issue](Python-Markdown/markdown#451)
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.
Hi @egrace479,
This looks great! I've reviewed each of the modified files in this PR and made some edits as additional commits.
You will see that I added one file, which is a configuration for markdownlint. By default, it uses 2 spaces rather than 4 spaces indent. I like two spaces. However, switching to two space indent inside nested checklists result in them not being indented in the rendered HTML.
This appears to be related to behaviour of the mkDocs renderer issue #545 Python-Markdown issue #3 also issue #451.
Assuming that you are not concerned with the indenting, I have left it as it was (4 spaces) and recorded this in .markdownlint.json
so that it won't complain.
If we do want to switch to two spaces (which I believe is more common in Markdown use) we could look at implementing the mdx_truly_sane_lists extension via our mkdocs.yaml
file like this.
Thank you for the thorough review and your thoughtful additions! Both the Model and Data Checklists are referencing the |
The Hugging Face interface specifically requires lowercase for licenses in the yaml portion.
Metadata-checklist.md
.docs/index.md
anddocs/wiki-guide/Digital-products-release-licensing-policy.md
, the former had a description rewrite).