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

first draft of operations episode #47

Merged
merged 9 commits into from
Jun 2, 2022
Merged

first draft of operations episode #47

merged 9 commits into from
Jun 2, 2022

Conversation

tobyhodges
Copy link
Member

@tobyhodges tobyhodges commented May 30, 2022

WIP - I want to add a figure for the life cycle before this gets merged. This is ready for review.

@tobyhodges tobyhodges marked this pull request as draft May 30, 2022 15:14
github-actions bot pushed a commit that referenced this pull request May 30, 2022
@github-actions
Copy link

github-actions bot commented May 30, 2022

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/lesson-development-training/compare/md-outputs..md-outputs-PR-47

The following changes were observed in the rendered markdown documents:

 17-operations.md         | 144 ++++++++++++++++++++++++++++++++++++++++-------
 fig/life_cycle.png (new) | Bin 0 -> 131034 bytes
 links.md                 |   2 +
 md5sum.txt               |   4 +-
 4 files changed, 129 insertions(+), 21 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 2022-06-01 10:54:04 +0000

@tobyhodges tobyhodges marked this pull request as ready for review May 30, 2022 17:34
github-actions bot pushed a commit that referenced this pull request May 30, 2022
episodes/17-operations.md Outdated Show resolved Hide resolved
tobyhodges and others added 2 commits May 30, 2022 19:51
Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>
github-actions bot pushed a commit that referenced this pull request May 30, 2022
github-actions bot pushed a commit that referenced this pull request May 30, 2022
@tobyhodges
Copy link
Member Author

The information I have included in this episode touches on the discussion in #25. My intention is that this new curriculum will render the Curriculum Development Handbook largely obsolete. We can provide an overview of the lesson stages here and go into more detail elsewhere e.g. in the community handbook or the documentation for the Incubator itself.

@zkamvar
Copy link
Contributor

zkamvar commented May 31, 2022

My intention is that this new curriculum will render the Curriculum Development Handbook largely obsolete.

Once this change happens, we should update the URLs introduced in carpentries/varnish#39

Copy link
Collaborator

@sstevens2 sstevens2 left a comment

Choose a reason for hiding this comment

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

Few small suggestions but otherwise good draft.

episodes/17-operations.md Outdated Show resolved Hide resolved
episodes/17-operations.md Outdated Show resolved Hide resolved
episodes/17-operations.md Outdated Show resolved Hide resolved
episodes/17-operations.md Outdated Show resolved Hide resolved
tobyhodges and others added 3 commits June 1, 2022 10:30
Co-authored-by: Sarah Stevens <sarah.stevens@wisc.edu>
Co-authored-by: Sarah Stevens <sarah.stevens@wisc.edu>
Co-authored-by: Sarah Stevens <sarah.stevens@wisc.edu>
github-actions bot pushed a commit that referenced this pull request Jun 1, 2022
github-actions bot pushed a commit that referenced this pull request Jun 1, 2022
github-actions bot pushed a commit that referenced this pull request Jun 1, 2022
episodes/17-operations.md Outdated Show resolved Hide resolved
Co-authored-by: Aleksandra Nenadic <a.nenadic@manchester.ac.uk>
github-actions bot pushed a commit that referenced this pull request Jun 1, 2022
@anenadic
Copy link
Collaborator

anenadic commented Jun 1, 2022

Great stuff @tobyhodges - ready to merge as far as I am concerned.

The only thing thing to consider adding at the end is a note on lesson translation/internationalisation just to make lesson developers aware. The internationalisation handbook uses Jekyll so it is not a match for the new lesson format and I am not sure how this is handled in the new Workbench. Still something worth pointing out?

Co-authored-by: Sarah Stevens <sstevens2@wisc.edu>

Co-authored-by: Sarah Stevens <sarah.stevens@wisc.edu>
@tobyhodges
Copy link
Member Author

The only thing thing to consider adding at the end is a note on lesson translation/internationalisation just to make lesson developers aware. The internationalisation handbook uses Jekyll so it is not a match for the new lesson format and I am not sure how this is handled in the new Workbench. Still something worth pointing out?

This is definitely something worth mentioning in this section, but right now I am not completely sure what we can put in - there is a larger discussion taking place about how best to incorporate internationalisation into the Workbench and into our curriculum processes in general. Nothing is resolved yet but we are actively working on a plan.

For now, I am going to merge this PR and assign an issue to myself to add some info about internationalisation and translations to the episode when I have something more tangible that I can write.

@tobyhodges
Copy link
Member Author

Thank you for the reviews @anenadic @sstevens2 🙌

@tobyhodges tobyhodges merged commit d6274ef into main Jun 2, 2022
github-actions bot pushed a commit that referenced this pull request Jun 2, 2022
Auto-generated via {sandpaper}
Source  : d6274ef
Branch  : main
Author  : Toby Hodges <tobyhodges@carpentries.org>
Time    : 2022-06-02 08:32:27 +0000
Message : Merge pull request #47 from carpentries/operations

first draft of operations episode
github-actions bot pushed a commit that referenced this pull request Jun 2, 2022
Auto-generated via {sandpaper}
Source  : ca51207
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2022-06-02 08:35:49 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : d6274ef
Branch  : main
Author  : Toby Hodges <tobyhodges@carpentries.org>
Time    : 2022-06-02 08:32:27 +0000
Message : Merge pull request #47 from carpentries/operations

first draft of operations episode
@tobyhodges tobyhodges deleted the operations branch June 10, 2022 14:34
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.

4 participants