-
Notifications
You must be signed in to change notification settings - Fork 229
Checklist comment
charlottejmc edited this page Aug 2, 2024
·
7 revisions
Contents of this page:
The following can be used as a template for our sustainability + accessibility checklist (original lessons):
Hello @Managing-Editor,
This lesson's sustainability + accessibility checks are in progress.
- Preview:
**EN:** <http://programminghistorian.github.io/ph-submissions/en/drafts/originals/lesson-slug>
**ES:** <http://programminghistorian.github.io/ph-submissions/es/borradores/originales/lesson-slug>
**FR:** <http://programminghistorian.github.io/ph-submissions/fr/en-cours/originales/lesson-slug>
**PT:** <http://programminghistorian.github.io/ph-submissions/pt/esbocos/originais/lesson-slug>
Publisher's sustainability + accessibility actions:
- [ ] Copyediting
- [ ] Typesetting
- [ ] Addition of Perma.cc links
- [ ] Check/resize images
- [ ] Check/adjust image filenames
- [ ] Receipt of author(s) copyright agreement ([EN declaration form](https://programminghistorian.org/assets/forms/Authorial-copyright-and-publishing-rights.pdf) / [ES formulario de declaración](https://programminghistorian.org/assets/forms/Derechos-de-autor-y-de-publicacion.pdf) / [FR formulaire de déclaration](https://programminghistorian.org/assets/forms/Droit-d-auteur-et-authorisation-de-publication.pdf) / [PT formulário de declaração](https://programminghistorian.org/assets/forms/Direitos-autorais-e-permissao-para-publicar.pdf)).
- [ ] Request DOI
- [ ] Remove outside contributors from ph-submissions
Authorial / editorial input to YAML:
- [ ] Define `difficulty:`, based on [the criteria set out here](https://github.com/programminghistorian/jekyll/wiki/defining-difficulty)
- [ ] Define the research `activity:` this lesson supports (acquiring, transforming, analysing, presenting, or sustaining) **Choose one**
- [ ] Define the lesson's `topics:` (api, python, data-management, data-manipulation, distant-reading, get-ready, lod ["Linked Open Data"], mapping, network-analysis, web-scraping, website ["Digital Publishing"], r, machine-learning, creative-coding, web-archiving or data-visualization) **Choose one or more. Let us know if you'd like us to add a new topic**. Topics are defined in [/_data/topics.yml](/https://github.com/programminghistorian/jekyll/blob/gh-pages/_data/topics.yml).
- [ ] Provide `alt-text` for all figures
- [ ] Provide a short `abstract:` for the lesson
- [ ] Agree an avatar (thumbnail image) to accompany the lesson
>The image must be:
>- copyright-free
>- non-offensive
>- an illustration (not a photograph)
>- at least 200 pixels width and height
>Image collections of the [British Library](https://www.flickr.com/photos/britishlibrary/albums), [Internet Archive Book Images](https://www.flickr.com/photos/internetarchivebookimages/), [Library of Congress Maps](https://www.loc.gov/maps/collections/) as well as their [Photos/Prints/Drawings](https://www.loc.gov/photos/collections/) or the [Virtual Manuscript Library of
>Switzerland](https://www.e-codices.unifr.ch/en) are useful places to search
- [ ] Provide `avatar_alt:` (visual description of that thumbnail image)
- [ ] Provide author(s) bio for `ph_authors.yml` using this template:
[REPLACE WITH THREE BACKTICKS ```]
- name: Forename Surname
orcid: 0000-0000-0000-0000
team: false
bio:
en: |
Forename Surname is an Assistant Professor in the Department of Subject at the University of City.
es: |
Forename Surname es profesor adjunto en el Departamento de Asignaturas de la Universidad de Ciudad.
fr: |
Forename Surname est professeur assistant au département des matières à l'université de City.
pt: |
Forename Surname é professor assistente no Departamento de Assunto da Universidade da Cidade.
[REPLACE WITH THREE BACKTICKS ```]
Files we are preparing for transfer to Jekyll:
**EN:**
- .md file: [/en/drafts/originals/lesson-slug.md](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/en/drafts/originals/lesson-slug.md)
- images: [/images/lesson-slug](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images/lesson-slug)
- assets: [/assets/lesson-slug](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets/lesson-slug)
- original avatar: [/gallery/originals](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/gallery/originals/lesson-slug-original.png)
- gallery avatar: [/gallery](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/gallery/lesson-slug.png)
**ES:**
- .md file: [/es/borradores/originales/lesson-slug.md](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/es/borradores/originales/lesson-slug.md)
- images: [/images/lesson-slug](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images/lesson-slug)
- assets: [/assets/lesson-slug](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets/lesson-slug)
- original avatar: [/gallery/originals](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/gallery/originals/lesson-slug-original.png)
- gallery avatar: [/gallery](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/gallery/lesson-slug.png)
**FR:**
- .md file: [/en-cours/originales/lesson-slug.md](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/fr/en-cours/originales/lesson-slug.md)
- images: [/images/lesson-slug](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images/lesson-slug)
- assets: [/assets/lesson-slug](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets/lesson-slug)
- original avatar: [/gallery/originals](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/gallery/originals/lesson-slug-original.png)
- gallery avatar: [/gallery](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/gallery/lesson-slug.png)
**PT:**
- .md file: [/esbocos/originais/lesson-slug.md](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/pt/esbocos/originais/lesson-slug.md)
- images: [/images/lesson-slug](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images/lesson-slug)
- assets: [/assets/lesson-slug](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets/lesson-slug)
- original avatar: [/gallery/originals](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/gallery/originals/lesson-slug-original.png)
- gallery avatar: [/gallery](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/gallery/lesson-slug.png)
Promotion:
- [ ] Prepare announcement post (using template)
- [ ] Prepare evergreen posts – @ManagingEditor, could you please provide x2 posts for future promotion via our social media channels? You can add these directly to the `ph-evergreens-twitter-x` spreadsheet that has been shared with you, or email them to me at publishing.assistant[@]programminghistorian.org.
Publisher's post-publication tasks:
- [ ] Add lesson slug to the Annual Count of Published Lessons
- [ ] Update the ph_data folder in the ph-contributors repository
The following can be used as a template for our sustainability + accessibility checklist (translated lessons):
Hello @ManagingEditor,
This lesson's sustainability + accessibility checks are in progress.
- Preview:
**EN:** <http://programminghistorian.github.io/ph-submissions/en/drafts/translations/lesson-file-name-here>
**ES:** <http://programminghistorian.github.io/ph-submissions/es/borradores/traducciones/lesson-file-name-here>
**FR:** <http://programminghistorian.github.io/ph-submissions/fr/en-cours/traductions/lesson-file-name-here>
**PT:** <http://programminghistorian.github.io/ph-submissions/pt/esbocos/traducoes/lesson-file-name-here>
Publisher's sustainability + accessibility actions:
- [ ] Typesetting
- [ ] Addition of Perma.cc links
- [ ] Addition of alt-text for all figures
- [ ] Check/resize images
- [ ] Check/adjust image filenames
- [ ] Receipt of translator's copyright agreement ([EN declaration form](https://programminghistorian.org/assets/forms/Authorial-copyright-and-publishing-rights.pdf) / [ES formulario de declaración](https://programminghistorian.org/assets/forms/Derechos-de-autor-y-de-publicacion.pdf) / [FR formulaire de déclaration](https://programminghistorian.org/assets/forms/Droit-d-auteur-et-authorisation-de-publication.pdf) / [PT formulário de declaração](https://programminghistorian.org/assets/forms/Direitos-autorais-e-permissao-para-publicar.pdf)).
- [ ] Request DOI
- [ ] Remove outside contributors from ph-submissions
Editorial input to YAML:
- [ ] Translation of `avatar_alt:`
- [ ] Translation of `abstract:`
- [ ] Translation of author(s) bio for `ph_authors.yml`
Files we are preparing for transfer to Jekyll:
**EN:**
- .md file: [/en/drafts/translations/lesson-file-name-here.md](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/en/drafts/translations/lesson-file-name-here.md)
- images: [/images/lesson-file-name-here](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images/original-lesson-file-name-here)
- assets: [/assets/lesson-file-name-here](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets/lesson-file-name-here)
**ES:**
- .md file: [/es/borradores/traducciones/lesson-file-name-here.md](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/es/borradores/traducciones/lesson-file-name-here.md)
- images: [/images/lesson-file-name-here](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images/original-lesson-file-name-here)
- assets: [/assets/lesson-file-name-here](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets/lesson-file-name-here)
**FR:**
- .md file: [/en-cours/traductions/lesson-file-name-here.md](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/fr/en-cours/traductions/lesson-file-name-here.md)
- images: [/images/lesson-file-name-here](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images/original-lesson-file-name-here)
- assets: [/assets/lesson-file-name-here](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets/lesson-file-name-here)
**PT:**
- .md file: [/esbocos/traducoes/lesson-file-name-here.md](https://github.com/programminghistorian/ph-submissions/blob/gh-pages/pt/esbocos/traducoes/lesson-file-name-here.md)
- images: [/images/lesson-file-name-here](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/images/lesson-file-name-here)
- assets: [/assets/lesson-file-name-here](https://github.com/programminghistorian/ph-submissions/tree/gh-pages/assets/lesson-file-name-here)
Promotion:
- [ ] Prepare announcement post (using template)
- [ ] Prepare evergreen posts – @ManagingEditor, could you please provide x2 posts for future promotion via our social media channels? You can add these directly to the `ph-evergreens-twitter-x` spreadsheet that has been shared with you, reply in a comment below, or email them to me at publishing.assistant[@]programminghistorian.org.
Publisher's post-publication tasks:
- [ ] Add lesson slug to the Annual Count of Published Lessons
- [ ] Update the ph_data folder in the ph-contributors repository
- Copyediting
- Copyedit comments
- Typesetting
- Archival Hyperlinks
- Copyright
- DOI
- Gallery image
- Checklist comment
- Handover comment
- Closing comment
- Opening comment Phase 0
- Phase change comment 1 to 2
- Phase change comment 2 to 3
- Phase change comment 3 to 4
- Opening comment Phase 4
- Phase change comment 4 to 5
- Phase change comment 5 to 6
- Phase change comment 6 to 7
- Tracking lesson phase changes
- Organisational Structure
- Trustee Responsibilities
- Trustee and Staff Roles
- Services to Publications
- Funding
Training
- Onboarding-Process-for-New-Editors
- Leading-a-Shadowing-process
- Board-of-Director---Continuing-Development
The Ombudsperson Role
Technical Guidance
- Making Technical Contributions
- Creating Blog Posts
- Service Integrations
- Brand Guidelines
- French Translation Documentation
- Technical Tutorial on Translation Links
- Technical Tutorial on Setting Up a New Language
- Technical Tutorial on Search
- Twitter Bot
- Achieving-Accessibility-Alt-text-Colour-Contrast
- Achieving-Accessibility:-Training-Options
Editorial Guidance
- Achieving Sustainability: Copyediting, Typesetting, Archival Links, Copyright Agreements
- Achieving Sustainability: Lesson Maintenance Workflow
- Achieving Sustainability-Agreed-terminology-PH-em-português
- Training and Support for Editorial Work
- The-Programming-Historian-Digital-Object-Identifier-Policy-(April-2020)
- How to Request a New DOI
- Service-Agreement-Publisher-and-Publications
- ProgHist-services-to-Publications
- Technical Tutorial on Setting Up a New Language
- Editorial Recruitment
Social Guidance
Finances
- Project Costs
- Spending-Requests-and-Reimbursement
- Funding Opportunities
- Invoice Template
- Donations and Fundraising Policies
Human Resources
- Privileges-and-Responsibilities-of-Membership
- Admin-when-team-members-step-down
- Team-Leader-Selection-Process
- Managing-Editor-Handover
- Checklist-for-Sabbaticals
- New Publications Policy
- Parental-Leave-Policy
Project Management
Project Structure
Board of Trustees