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

Document CFF support #192

Merged
merged 3 commits into from
Apr 11, 2024
Merged

Document CFF support #192

merged 3 commits into from
Apr 11, 2024

Conversation

tobyhodges
Copy link
Member

Closes #188 by documenting current support for CFF.

I will update this section with another PR soon:

  1. when the CLDT curriculum has been updated to include guidance for lesson developers about what information to include in their CFF
  2. when sandpaper includes a template CFF file

Copy link

github-actions bot commented Apr 11, 2024

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/carpentries/sandpaper-docs/compare/md-outputs..md-outputs-PR-192

The following changes were observed in the rendered markdown documents:

 editing.md | 101 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 md5sum.txt |   2 +-
 2 files changed, 102 insertions(+), 1 deletion(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-04-11 14:57:52 +0000

github-actions bot pushed a commit that referenced this pull request Apr 11, 2024
github-actions bot pushed a commit that referenced this pull request Apr 11, 2024
@froggleston froggleston merged commit ca2c0b3 into main Apr 11, 2024
3 checks passed
@froggleston froggleston deleted the 188-document-cff-support branch April 11, 2024 14:59
github-actions bot pushed a commit that referenced this pull request Apr 11, 2024
Auto-generated via {sandpaper}
Source  : ca2c0b3
Branch  : main
Author  : Robert Davey <[email protected]>
Time    : 2024-04-11 14:59:03 +0000
Message : Merge pull request #192 from carpentries/188-document-cff-support

Document CFF support
github-actions bot pushed a commit that referenced this pull request Apr 11, 2024
Auto-generated via {sandpaper}
Source  : 5adbbbb
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-04-11 15:00:03 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : ca2c0b3
Branch  : main
Author  : Robert Davey <[email protected]>
Time    : 2024-04-11 14:59:03 +0000
Message : Merge pull request #192 from carpentries/188-document-cff-support

Document CFF support
github-actions bot pushed a commit that referenced this pull request Apr 16, 2024
Auto-generated via {sandpaper}
Source  : 5adbbbb
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-04-11 15:00:03 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : ca2c0b3
Branch  : main
Author  : Robert Davey <[email protected]>
Time    : 2024-04-11 14:59:03 +0000
Message : Merge pull request #192 from carpentries/188-document-cff-support

Document CFF support
github-actions bot pushed a commit that referenced this pull request Apr 23, 2024
Auto-generated via {sandpaper}
Source  : 5adbbbb
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-04-11 15:00:03 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : ca2c0b3
Branch  : main
Author  : Robert Davey <[email protected]>
Time    : 2024-04-11 14:59:03 +0000
Message : Merge pull request #192 from carpentries/188-document-cff-support

Document CFF support
github-actions bot pushed a commit that referenced this pull request Apr 30, 2024
Auto-generated via {sandpaper}
Source  : 5adbbbb
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-04-11 15:00:03 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : ca2c0b3
Branch  : main
Author  : Robert Davey <[email protected]>
Time    : 2024-04-11 14:59:03 +0000
Message : Merge pull request #192 from carpentries/188-document-cff-support

Document CFF support
github-actions bot pushed a commit that referenced this pull request May 7, 2024
Auto-generated via {sandpaper}
Source  : 5adbbbb
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-04-11 15:00:03 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : ca2c0b3
Branch  : main
Author  : Robert Davey <[email protected]>
Time    : 2024-04-11 14:59:03 +0000
Message : Merge pull request #192 from carpentries/188-document-cff-support

Document CFF support
github-actions bot pushed a commit that referenced this pull request May 14, 2024
Auto-generated via {sandpaper}
Source  : 5adbbbb
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-04-11 15:00:03 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : ca2c0b3
Branch  : main
Author  : Robert Davey <[email protected]>
Time    : 2024-04-11 14:59:03 +0000
Message : Merge pull request #192 from carpentries/188-document-cff-support

Document CFF support
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.

Document support for Citation File Format
2 participants