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

WIP: DOC: Add a BibTeX file with the recommended ITK references #4138

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jhlegarreta
Copy link
Member

Add a BibTeX file with the recommended ITK references.

PR Checklist

@github-actions github-actions bot added the area:Documentation Issues affecting the Documentation module label Jul 30, 2023
@jhlegarreta
Copy link
Member Author

Notes:

Add a BibTeX file with the recommended ITK references.
@jhlegarreta
Copy link
Member Author

What about https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files ?

Interesting @gdevenyi, thanks ! In that case a tool to convert the BibTeX files into CFF should be run prior to adding them, e.g.
https://github.com/citation-file-format/citation-file-format/blob/main/README.md#tools-to-work-with-citationcff-files-wrench

I believe the primary input data should still be BibTeX format. If you wish, you could open an issue to do this: a GHA workflow could be set up to do this, and to write them to the same folders as the BibTeX files, and if something has changed, the action would automatically open a PR ?

Maybe it can be left as a separate/future PR, and to get the CFF files for the first time, we can run it manually, and add the files to this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:Documentation Issues affecting the Documentation module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants