Guidelines update

[rivaquiroga]

This PR makes three four pending updates in our guidelines:

Author Guidelines

• software citation (Closes Software citation #1984)
• lesson maintenance ( Lesson Maintenance Workflow #2058 )
• alert on lessons that require relatively substantial computing resources (Closes Technological resources metric or ratings for resource intensive lessons #1712)

Editor Guidelines

• use of mathjax: true in Editor Guidelines (Closes Mathematical formulas visualisation problem #2053)

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.

[acrymble]

@rivaquiroga is this something @Anisa-ProgHist can help you to close and merge?

[anisa-hawes]

I met with Riva yesterday and we discussed updating en/author-guidelines.md to reflect recent revisions to the Lesson Maintenance workflow. I have proposed a new paragraph, see above or view directly here: 12574f3. This update requires translation so that it can also be added to es/guia-para-autores.md. I will request pt and fr translations next week as separate Issues.

--

Hello @programminghistorian/spanish-team,

Please can you help to translate the following paragraph into Spanish?:

en/author-guidelines.md

What happens after your lesson is published?

Occasionally, we receive feedback from users who have encountered an error while completing one of our lessons. If this happens, our Publishing Assistant will open an Issue on GitHub, then carry out an assessment to confirm whether the error reported represents a problem caused by the user (editing the lesson's code or changing its dataset, for example) or a problem within the lesson itself. If the latter, our Publishing Assistant will re-test the relevant part(s) of the lesson and undertake research to identify a fix. As part of this Lesson Maintenance process, we may contact you alongside other members of the Programming Historian team to ask for advice. In the case that no fix can be found, we will propose adding a warning to the lesson explaining that some users may encounter an error. Where possible, the warning should include links to further reading, empowering users to identify a solution themselves.

With many thanks, Anisa

[rivaquiroga]

Thanks, @Anisa-ProgHist!
The translation is ready now.
I was wondering if we should explain in this paragraph how we are going to contact authors, so they can expect the email + github mention in case an error is reported on their lesson.

[rivaquiroga]

@drjwbaker, it seems that Liber Quarterly made some changes in their web page and now the link to your article there is broken: https://www.liberquarterly.eu/article/10.18352/lq.10176. The new one is: https://liberquarterly.eu/article/view/10847. The DOI is not working either, as it point to the broken link. Maybe you want to contact them to let them know.

[anisa-hawes]

Thank you, @rivaquiroga! My apologies, I did not see your question above, about mentioning how we will contact authors (via email or via GitHub). In our Conversation within #2058, we have been thinking about this too. The discussion includes the question of whether we should we should ask authors to provide an alternative email address (personal rather than institutional) at the Lesson Proposal stage to facilitate this, or whether this means we are collecting/holding too much personal data. My sense from speaking with Adam is that contacting authors about Lesson Maintenance issues should really be a last resort option, and that revisions of our sustainability guidelines should also reduce the frequency of us/users encountering these errors. With these thoughts in mind, do you agree that it makes sense to leave the Author Guidelines as they are for now?

[rivaquiroga]

Sounds good!