search

carpentries-incubator / scientific-metadata

Introduction to the Fundamentals of Scientific Metadata
https://carpentries-incubator.github.io/scientific-metadata/
Other
6 stars 0 forks source link

Awesome dev - Release of lesson version 1.0 #1

Closed SilkeGerlich closed 11 months ago

SilkeGerlich commented 1 year ago

This pull request closes issues

2 #3 #4 #5

Version 1.0 of the Carpentries Incubator Lesson "Fundamentals of scientific metadata"

Content Review:

github-actions[bot] commented 1 year ago

Thank you!

Thank you for your pull request :smiley:

:robot: 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:

Rendered Changes

:mag: Inspect the changes: https://github.com/carpentries-incubator/scientific-metadata/compare/md-outputs..md-outputs-PR-1

The following changes were observed in the rendered markdown documents:

 LICENSE.md                                         |   97 +-
 acknowledgements.md (new)                          |   28 +
 config.yaml                                        |   52 +-
 data-metadata.md                                   |  345 +-
 data/README_exampleDataObject.txt (new)            |   15 +
 data/exampleDataObject.txt (new)                   | 6238 ++++++++++++++++++++
 enabling-technologies-standards.md                 |  430 +-
 exampleGroupHandoutPreview.png (new)               |  Bin 0 -> 336590 bytes
 fig/CLICKinformationPyramid.png (new)              |  Bin 0 -> 491732 bytes
 fig/bernyHughesPersona.png (new)                   |  Bin 0 -> 624387 bytes
 fig/coffee.svg (new)                               |    1 +
 fig/external-link.svg (new)                        |    1 +
 fig/github.svg (new)                               |    1 +
 fig/home.svg (new)                                 |    1 +
 fig/lindaSieversPersona.png (new)                  |  Bin 0 -> 802244 bytes
 fig/link.svg (new)                                 |    1 +
 fig/linkedin.svg (new)                             |    1 +
 fig/mail.svg (new)                                 |    1 +
 fig/portraitAnnika.png (new)                       |  Bin 0 -> 837621 bytes
 fig/portraitSilke.png (new)                        |  Bin 0 -> 952804 bytes
 fig/robertMedinaPersona.png (new)                  |  Bin 0 -> 993019 bytes
 files/AUTHOR_DATASET_ReadmeTemplate.txt (new)      |   97 +
 files/CLICKexampleAhaslidesPid.png (new)           |  Bin 0 -> 241054 bytes
 files/CLICKexampleCrossref.png (new)               |  Bin 0 -> 180527 bytes
 files/CLICKexampleDataObjectColor.png (new)        |  Bin 0 -> 321975 bytes
 files/CLICKexampleError404.png (new)               |  Bin 0 -> 255234 bytes
 files/CLICKexampleFeedbackDay1.png (new)           |  Bin 0 -> 466054 bytes
 files/CLICKexampleGroupHandoutPreview.png (new)    |  Bin 0 -> 393125 bytes
 files/CLICKliveCodingScreenshot.png (new)          |  Bin 0 -> 377085 bytes
 files/exampleCrossref.png (new)                    |  Bin 0 -> 185090 bytes
 files/exampleError404.png (new)                    |  Bin 0 -> 214965 bytes
 files/exampleFeedbackDay1.png (new)                |  Bin 0 -> 290249 bytes
 files/internalEvaluationForm.txt (new)             |   56 +
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 4177755 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 4623684 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1663976 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1978379 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1227158 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 2733928 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1067092 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 3629130 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 5380664 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 2358162 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 6928910 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 4449996 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 7341262 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1102539 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 2666338 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1715935 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1085133 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 5475262 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 3093211 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1697050 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1316170 bytes
 further-reading.md (new)                           |   27 +
 general-lesson-information.md                      |  140 +-
 getting-started.md                                 |   31 +-
 index.md                                           |   47 +-
 instructor-guide.md                                | 1389 ++++-
 instructor-notes.md                                |    4 +-
 introduction.md (gone)                             |  102 -
 learner-profiles.md                                |   33 +-
 links.md                                           |    4 +-
 md5sum.txt                                         |   28 +-
 meet-the-creators.md (new)                         |   22 +
 reference.md (new)                                 |   38 +
 setup.md                                           |   46 +-
 structure-schema.md                                |  242 +-
 web-location-identifiers.md                        |  447 +-
 69 files changed, 9204 insertions(+), 761 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.

:stopwatch: Updated at 2023-10-15 20:44:31 +0000

apirogov commented 1 year ago

I collect general comments and high-level problems in this issue, and will use this PR to mark certain concrete sections.

apirogov commented 1 year ago

General comment:

I think, given that the script for the slides is provided in that detail, it should also have the markup in there. The summary in the learners' view uses more markup, but for an instructor, might also be helpful to highlight "new definitions" and "emphasis" ... as you nicely explained the purpose of markup in the corresponding lecture ;)