Skip to content

Update config, README, and contributor docs#8

Merged
elichad merged 11 commits intomainfrom
update-config
Apr 30, 2025
Merged

Update config, README, and contributor docs#8
elichad merged 11 commits intomainfrom
update-config

Conversation

@elichad
Copy link
Copy Markdown
Contributor

@elichad elichad commented Apr 17, 2025

Fixes #7 and migrates some of the files that were lost in transition (LICENSE and CONTRIBUTING). For CONTRIBUTING I updated it using the latest version from the Carpentries template: https://github.com/carpentries/workbench-template-md/blob/main/CONTRIBUTING.md.

Also moves the files/rainfall-1.2.1 folder under episodes/ - I think this is necessary for sandpaper to render it. The ro-crate-preview.html file was also lost in transition so I re-created it with rochtml (and copied it to index.html for good measure). ro-crate-dynamic.js is no longer needed as it's now hosted somewhere by (I presume) the LDaCA team.

@elichad elichad requested a review from douglowe April 17, 2025 16:20
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 17, 2025

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/ResearchObject/packaging_data_with_ro-crate/compare/md-outputs..md-outputs-PR-8

The following changes were observed in the rendered markdown documents:

 CODE_OF_CONDUCT.md (new)                          |   3 +
 LICENSE.md (new)                                  |  36 +++
 config.yaml                                       |  61 ++---
 files/rainfall-1.2.1/data.csv (new)               |   3 +
 files/rainfall-1.2.1/index.html (new)             | 314 ++++++++++++++++++++++
 files/rainfall-1.2.1/ro-crate-metadata.json (new) |  76 ++++++
 files/rainfall-1.2.1/ro-crate-preview.html (new)  | 314 ++++++++++++++++++++++
 md5sum.txt                                        |   4 +-
 8 files changed, 778 insertions(+), 33 deletions(-)
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 2025-04-30 13:20:48 +0000

github-actions Bot pushed a commit that referenced this pull request Apr 17, 2025
github-actions Bot pushed a commit that referenced this pull request Apr 25, 2025
github-actions Bot pushed a commit that referenced this pull request Apr 25, 2025
Copy link
Copy Markdown
Collaborator

@douglowe douglowe left a comment

Choose a reason for hiding this comment

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

I think it looks okay. I've noted 2 minor items to address, but otherwise we can merge this I think.

Comment thread LICENSE.md

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Note the warning from GH actions that this should be in the form text

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

ignoring the warning as this block is using the boilerplate taken from How to apply the Apache License to your work

Comment thread README.md Outdated
github-actions Bot pushed a commit that referenced this pull request Apr 30, 2025
@elichad elichad merged commit 486f9c4 into main Apr 30, 2025
3 checks passed
github-actions Bot pushed a commit that referenced this pull request Apr 30, 2025
Auto-generated via `{sandpaper}`
Source  : 486f9c4
Branch  : main
Author  : Eli Chadwick <eli.chadwick@manchester.ac.uk>
Time    : 2025-04-30 13:21:23 +0000
Message : Merge pull request #8 from ResearchObject/update-config

Update config, README, and contributor docs
github-actions Bot pushed a commit that referenced this pull request Apr 30, 2025
Auto-generated via `{sandpaper}`
Source  : cde2890
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-04-30 13:22:02 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 486f9c4
Branch  : main
Author  : Eli Chadwick <eli.chadwick@manchester.ac.uk>
Time    : 2025-04-30 13:21:23 +0000
Message : Merge pull request #8 from ResearchObject/update-config

Update config, README, and contributor docs
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.

Update links in footer

2 participants