Skip to content

Conversation

@anisa-hawes
Copy link
Contributor

I am updating the lesson templates, simplifying the YAML to the minimum + upper three dashes --- + authors: with the understanding that editors / or technical editor will add in the remaining fields later in the workflow:

This change aims to reduce early-phase errors for authors and editors, and updates en/lesson-template.md, es/plantilla-leccion.md, fr/modele-tuto.md, and pt/licoes-modelo.md.

Closes #1995

Checklist

  • Assign yourself in the "Assignees" menu
  • Assign at least one individual or team to "Reviewers"
    • if the text needs to be translated, assign the relevant language team(s) as "Reviewers" and tag both the team as well as the managing edtor in your PR. Please follow the translation request guidelines when writing your PR description
  • Add the appropriate "Label"
  • Ensure the status checks pass
  • Check the live preview of your PR on Netlify
  • If this PR closes an open issue, add the phrase Closes #ISSUENUMBER to the description above

If you are having difficulty fixing build errors, first consult https://github.com/programminghistorian/jekyll/wiki/Making-Technical-Contributions carefully, especially "Common Build Errors". Then contact the technical team if you need further help.

Simplifying YAML to the minimum requirements for initial submission.
Simplifying YAML to the minimum requirements for initial submission.
Simplifying YAML to the minimum requirements for initial submission.
Simplifying YAML to the minimum requirements for initial submission.
Correcting typing error. Adding number 2, instead of repeating 1.
@anisa-hawes
Copy link
Contributor Author

Hello @rivaquiroga. Just to note this update in connection to our conversation last week.

Copy link
Member

@ZoeLeBlanc ZoeLeBlanc left a comment

Choose a reason for hiding this comment

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

This all looks great to me! Assuming you'll be adding in documentation for adding in these other metadata yaml fields for managing editors and wondering if we need to discuss whether translations need more initial fields or not? Will MEs know that a lesson is a translation? Is that something we need to add into our process for bringing over files? Regardless think you can go ahead with these updates! Thanks @anisa-hawes

@anisa-hawes
Copy link
Contributor Author

Thank you @ZoeLeBlanc. Yes, I think we meet our key objective which is to reduce errors when new submissions are uploaded. I'll note this into the re-draft guidelines and make a note about translations too. I will also raise this at the meeting of MEs in January #2346

@anisa-hawes anisa-hawes merged commit 06bdba3 into gh-pages Dec 22, 2021
@anisa-hawes anisa-hawes deleted the Issue-1995 branch December 22, 2021 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Updating Initial Lesson Metadata Guidelines

3 participants