carpentries-incubator / scientific-metadata

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

update sandpaper to 0.12.4, fix technical issues, replace HTML with MD where possible, fix typos #9

Closed apirogov closed 1 year ago

apirogov commented 1 year ago

As a result of the technical review I opened and commented on some issues with sandpaper:

This is just for the record, as we wanted to give feedback concerning the workbench (I think there were still some more things we wanted to report / suggest).

The lesson now successfully builds with latest sandpaper and I checked that the pages look still fine, the markup works, etc.

Still TODO:

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-9

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 +
 enabling-technologies-standards.md                 |  426 +++++--
 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/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/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 -> 3724894 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 4172712 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1226789 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1526556 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 777254 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 2280872 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 614305 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 3177847 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 4880850 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 2497986 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 5272010 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 2687489 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 649793 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 2213916 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1263156 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 632276 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 5037269 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 2642075 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 1248313 bytes
 ...rpentriesIncubator_ScientificMetadata.pdf (new) |  Bin 0 -> 865342 bytes
 further-reading.md (new)                           |   23 +
 general-lesson-information.md                      |  140 ++-
 getting-started.md                                 |   31 +-
 index.md                                           |   47 +-
 instructor-guide.md                                | 1312 ++++++++++++++++++--
 instructor-notes.md                                |    4 +-
 introduction.md (gone)                             |  102 --
 learner-profiles.md                                |   33 +-
 links.md                                           |    4 +-
 md5sum.txt                                         |   27 +-
 meet-the-creators.md (new)                         |   22 +
 setup.md                                           |   46 +-
 structure-schema.md                                |  238 +++-
 web-location-identifiers.md                        |  358 +++++-
 63 files changed, 2758 insertions(+), 752 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-09-11 10:43:17 +0000