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

Workbench changes #89

Merged
merged 7 commits into from
Mar 22, 2023
Merged

Workbench changes #89

merged 7 commits into from
Mar 22, 2023

Conversation

jcolomb
Copy link
Collaborator

@jcolomb jcolomb commented Feb 20, 2023

No description provided.

@github-actions
Copy link

github-actions bot commented Feb 20, 2023

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-incubator/managing-computational-projects/compare/md-outputs..md-outputs-PR-89

The following changes were observed in the rendered markdown documents:

 index.md   | 1 -
 md5sum.txt | 2 +-
 2 files changed, 1 insertion(+), 2 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 2023-03-22 08:00:08 +0000

@jcolomb
Copy link
Collaborator Author

jcolomb commented Feb 20, 2023

or should we add another way to make comments ?

@tobyhodges
Copy link
Member

Here's a nice example of a README being updated after transition to the Workbench: datacarpentry/r-raster-vector-geospatial#382

@@ -10,7 +10,6 @@ Through lessons learned in this training, researchers will enhance their underst

<p>Funding Acknowledgement: The first iteration of this project was funded by <a href="https://www.turing.ac.uk">The Alan Turing Institute</a> - <a href="https://www.turing.ac.uk/research/asg">AI for Science and Government</a> (ASG) Research Programme from October 2021 to March 2022.</p>

{% comment %} This is a comment in Liquid {% endcomment %}
Copy link
Member

Choose a reason for hiding this comment

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

You could substitute in <!-- HTML comments -->? Or, @zkamvar, is there a specific comment syntax for (R)Markdown files?

Copy link
Contributor

Choose a reason for hiding this comment

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

HTML comments is correct!

@jcolomb
Copy link
Collaborator Author

jcolomb commented Mar 7, 2023

Here's a nice example of a README being updated after transition to the Workbench: datacarpentry/r-raster-vector-geospatial#382

both there and here, the best would be to have an updated contributing.md file, is there any in the template ?

@zkamvar
Copy link
Contributor

zkamvar commented Mar 7, 2023

Here's a nice example of a README being updated after transition to the Workbench: datacarpentry/r-raster-vector-geospatial#382

both there and here, the best would be to have an updated contributing.md file, is there any in the template ?

Why yes there is! It's here: https://github.com/carpentries/sandpaper/blob/main/inst/templates/contributing-template.txt

... uhm this is embarassing. I have not actually done anything to update it from the former template -_-. I'm currently battling a particularly nasty bug (carpentries/sandpaper#406) and I will do my best to update it when I get time.

@jcolomb
Copy link
Collaborator Author

jcolomb commented Mar 8, 2023

ok tried to make some changes at carpentries/sandpaper#407

will probably be make changes there and update here using some sandpaper function, right?

@zkamvar
Copy link
Contributor

zkamvar commented Mar 8, 2023

will probably be make changes there and update here using some sandpaper function, right?

The update will be copy/paste since this is a markdown file that {sandpaper} only touches at the creation of the lesson.

github-actions bot pushed a commit that referenced this pull request Mar 22, 2023
m
Merge branch 'workbench-changes' of github.com:carpentries-incubator/managing-computational-projects into workbench-changes

# Conflicts:
#	CONTRIBUTING.md
github-actions bot pushed a commit that referenced this pull request Mar 22, 2023
github-actions bot pushed a commit that referenced this pull request Mar 22, 2023
@jcolomb jcolomb merged commit 78b2b02 into main Mar 22, 2023
@jcolomb jcolomb deleted the workbench-changes branch March 22, 2023 08:02
github-actions bot pushed a commit that referenced this pull request Mar 22, 2023
Auto-generated via {sandpaper}
Source  : 78b2b02
Branch  : main
Author  : Julien Colomb <[email protected]>
Time    : 2023-03-22 08:01:44 +0000
Message : Merge pull request #89 from carpentries-incubator/workbench-changes

Workbench changes
github-actions bot pushed a commit that referenced this pull request Mar 22, 2023
Auto-generated via {sandpaper}
Source  : 5f499f6
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-03-22 08:03:54 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 78b2b02
Branch  : main
Author  : Julien Colomb <[email protected]>
Time    : 2023-03-22 08:01:44 +0000
Message : Merge pull request #89 from carpentries-incubator/workbench-changes

Workbench changes
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.

3 participants