Update Guidelines for Submitting Lessons to ph-submissions

[walshbr]

Closes #1795. Note that this will be a draft pull request for feedback from the technical team and MEs. It will not be finalized until after the Portuguese team has finalized their work, as this pull request affects files that they are currently translating.

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 Travis CI 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 Travis errors, first consult https://github.com/programminghistorian/jekyll/wiki/Making-Technical-Contributions carefully, especially "Common Travis Errors". Then contact the technical team if you need further help.

[walshbr]

@programminghistorian/technical-team - can one of you take a look at the instructions here to make sure that I've updated correctly based on our new policy to have authors email in their submissions for the editors to then upload the materials to ph-submissions.

@svmelton - since we just tried this out with the English team, could you read the diff as well to make sure it makes sense? https://github.com/programminghistorian/jekyll/pull/1844/files.

Note again that this is meant to remain drafted until after the Portuguese team is done translating their materials. So won't ask for review and translation until that time. @acrymble - I assume that leaving edits in draft form like this still respects their need to have the documents frozen so they remain in synch while also allowing us to keep working. But let me know if that's not the case.

[acrymble]

@walshbr if you're making changes the portuguese team might like the option of just doing it right the first time? Maybe send them a message and find out. Reducing overall effort is a good thing.

[DanielAlvesLABDH]

We will open and edit one file at a time, from the list mentioned in #1818, so if you want we can leave this file to last and then incorporate the changes made

[walshbr]

Yeah I agree @acrymble - I was thinking the same thing. the more I think about it, though, @DanielAlvesLABDH - I'm inclined to just hold this pull request for now until we get the Portuguese team entirely merged. It feels a little hairy to try to coordinate multiple versions and keep track of what files are in what working state. Even just trying to make sense of the plan in the abstract I am finding a little difficult. So I'll keep this drafted for now and we can touch base when PT is merged?

[DanielAlvesLABDH]

Fine

[svmelton]

Thanks, @walshbr—the diff looks good to me, whenever we're ready to move forward.

[walshbr]

@programminghistorian/technical-team is going to review the language here before asking for translations.

[jenniferisasi]

Maybe on author-guidelines on step 1 you don't need to say that the account gives permission to upload; I think that might be confusing since they are not supposed to upload anything themselves. Maybe just "grant access to use our repository during he peer-review process". What do you think?

[walshbr]

@jenniferisasi I think under this system we would just be having the editors do the initial upload of new materials so they can do initial revisions to the metadata and syntax. But ultimately we want them to then start working from and revising that file, right? (we don't want the editor to have to continually get a new version and re-upload it for the authors). So maybe…

A clarifying note in step one as you say, clarifying that this first upload will be done by the editor. and then in step four or five noting that future revisions to the lesson should be done to the file on the ph submissions lesson itself.

Does that seem to make sense to you as a process?

[jenniferisasi]

@jenniferisasi I think under this system we would just be having the editors do the initial upload of new materials so they can do initial revisions to the metadata and syntax. But ultimately we want them to then start working from and revising that file, right? (we don't want the editor to have to continually get a new version and re-upload it for the authors). So maybe…

A clarifying note in step one as you say, clarifying that this first upload will be done by the editor. and then in step four or five noting that future revisions to the lesson should be done to the file on the ph submissions lesson itself.

Does that seem to make sense to you as a process?

It does! Send file to editor, editor uploads, then edits happen through GitHub. As it reads right now, the user could think: "oh, so I need to upload it and the editor has to find the file name in the repo".

[walshbr]

@jenniferisasi I made changes to reflect your suggestions if you want to modify/dismiss your review.

[DanielAlvesLABDH]

Just to let you know that I updated the Portuguese files

[DanielAlvesLABDH]

Made the changes to the PT files

[mariechristineb]

@spapastamkou I added comments to 24e7594

[rivaquiroga]

@jenniferisasi, el único cambio que faltaba en la guía para autores y la guía para traductores era el punto 5 de estas indicaciones. Lo demás ya lo habíamos traducido con Maria José (este PR estuvo un tiempo como draft, así que aprovechamos mientras tanto de incorporar estos cambios en #1771).
Ya incorporé en #1771 ese punto (y una frase extra que agregaron en el número 1), así que lo único que por parte del equipo de español faltaría en este PR es agregar esta nueva información a la Guía del Editor.

[spapastamkou]

In integrated @mariechristineb comments in the FR guidelines and updated the branch.

[walshbr]

@jenniferisasi @DanielAlvesLABDH @spapastamkou - just a note that if the translations from your team are finished you should go ahead and give an approving review on the pull request so that I can merge. Thank you!

[DanielAlvesLABDH]

PT translations are ok

[jenniferisasi]

@walshbr I probably have the silliest question ever: If I work directly on the branch for this PR, it doesn't show me the latest file that Riva pushed today (guía para autores) onto which I want to make the changes asked for in this PR ... if we update this branch somehow, will the right file show?

[walshbr]

It's not a silly question @jenniferisasi - you have to re-merge the main branch into older branches when the main one changes. And there's no clear way to do that in the github interface that I've ever seen (@ZoeLeBlanc might know otherwise). I just did so, though, so you should see the latest files now.

[jenniferisasi]

Ok, I think with my uploads this issue is ready to be closed (once we re-approve).

[walshbr]

I think if you just approve @jenniferisasi I should be good to merge. Nothing has changed on the Fr or Pt sides that would require them to re-review.

[jenniferisasi]

approved!