Skip to content

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

Open
wants to merge 32 commits into
base: main
Choose a base branch
from
Open

Add FAIR Guide with Checklists #37

wants to merge 32 commits into from

Conversation

egrace479
Copy link
Member

@egrace479 egrace479 commented Apr 8, 2025

  • Replaces "Metadata Guide" tab with "FAIR Guide". Includes references for FAIR and Reproducibility, motivates use of checklists.
  • Metadata Guide rebranded to Metadata Checklist--a more general guideline for necessary metadata.
    • Renamed the actual file Metadata-checklist.md.
    • Adjusted URLs accordingly and revised the references to it or redirected them to the FAIR-Guide page as appropriate (redirects in docs/index.md and docs/wiki-guide/Digital-products-release-licensing-policy.md , the former had a description rewrite).
  • Adds checklists for Code, Data, and Model repositories to follow FAIR principles.
    • Data and Model checklists follow the dataset and model cards, respectively.

Screenshot 2025-04-08 at 1 17 10 PM

egrace479 and others added 11 commits February 14, 2025 18:02
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
@egrace479 egrace479 added the enhancement New feature or request label Apr 8, 2025
… other checklists

Adjust descriptions when referencing it accordingly
Copy link
Collaborator

@gwtaylor gwtaylor left a 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.

@egrace479
Copy link
Member Author

Hi @egrace479, This looks great! I've reviewed each of the modified files in this PR and made some edits as additional commits.

...
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 yaml in their respective HF cards, which require lowercase for licensing (as noted in suggestions). Additionally, I thought adding one more clarifying sentence on what constitutes an issue tracker might be helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants