[MILESTONE CHECKLIST] Complete prototype the Our Handbook template.

[NatalieZelenka]

A full list of everything we'd like in the full handbook! Look here for general inspiration on what to work on (unrelated to specific events).

Setup

• GitHub infrastructure (Basic GitHub infrastructure #7)
  • Issue templates for instanced book (Create issue templates (for use in instanced handbooks) #16)
• Jupyter Book infastructure:
  • Basics (Basic JupyterBook infrastucture #8)

Create sections for the following pages

Here's a list of potential sections for the handbook

• Welcome (Welcome page #9)
  • Update the links in the note.
• Our research environment (define research culture/environment).
  • Our physical/digital environment (core hours? city stuff? uni stuff? part time?)
  • Our values (Our values #10)
  • Our chosen tools ([TEMPLATE SECTION] Our chosen tools #5)
  • Our research interests (Our Research Interests #11)
  • Our activities (Our outputs and activities #12)
  • Our roadmap ([TEMPLATE SECTION] Our roadmap #6)
• Our team ([NEW SECTION] ✨ Our Team #18)
  • Team members (incl. social media, etc, something fun/a quote, links to projects worked on)
  • Skills and strengths
  • Past team members
  • Joining our team
• Roles and responsibilities
  • Shared responsibilities (e.g. administration like organising group meetings or coffee breaks)
  • Research Internships
  • Academic group
    • PhD guide
    • Postdoc guide
    • Principal Investigator(s)
    • Group leader
  • Research Software Engineering group
    • RSE
    • Senior RSE
    • Lead RSE
  • Extra roles (e.g. maintaining GitHub repos, the group website, the handbook, first aid, fire steward, etc).
• Projects (project overview from roadmap)
  • New (but definitely happening) projects
  • Ongoing projects
  • Past projects
• How we work
  • Coffee breaks
  • Group meetings (Group meetings #14)
  • Journal clubs
  • Away days
  • Conferences and other talks
  • Publishing
  • Research practices
    • Reproducibility
    • Software engineering practices
  • Group side projects (away "weeks")
  • One-to-ones
  • Annual reviews
    • Template for staff annual review (Template for staff annual review  #3)
    • Template for PhD annual review (Template for PhD annual review #4)
  • Other stuff (e.g. hackathons, teaching, extra work, outreach, etc).
• Useful resources
  • New team member checklist ( New team member checklist #13)
  • Running a project (flow-chart)
    • Ethics
    • Working "open" [NEW SECTION] ✨ (Open) Research Practices #30
    • Working reproducibly
    • Git/GitHub
      • Template data analysis repository
      • Template software repositories (one per language)
    • Testing
    • Continuous integration
    • Documentation
  • Credit + contributions
  • Applying for grants/funding
  • Wellbeing
    • Email charter
    • University Resources
    • Nice walks nearby
  • Time management [NEW SECTION, RESOURCE] ✨ Time management/prioritisation #31
    • Prioritising
      • Eisenhower matrix
      • Mental Inventory (https://bulletjournal.com/blogs/bulletjournalist/mental-inventory)
    • Pomodoro technique
    • Co-working/working meetings
  • Running Events
    • Tick list
    • Code of conduct
• Glossary (group jargon and acronyms)

---

Small other to-dos

• Check all the links jupyter-book build mybookname/ --builder linkcheck
• Update the link in _config.yml extra_navbar to be the deployed Our Meta Handbook

[NatalieZelenka]

How will template sections work?

Technically how will they work, e.g.:
- will there be scripts to generate based on input?
- will different choices be presented as subsections with instructions to choose your favourite
- will we differentiate between sections that are suitable as-is and sections that are not (e.g. are more examples)
- will it be like a choose your own adventure with instructions to the readers in comments? Possibly with TODOs?
- will some sections be optional (will they be hidden from sphinx by using a leading underscore?)

Style-wise how will it work? e.g.:
- how opinionated should we be?
- how many different options should we present?
- what tense should we be writing in?
- should we prefer "as-is" or examples (where both is not possible)?
- will we have parts to "guide" writing (like in the Mozilla open leaders program with the mission/value statement), and if so, should this go in the handbook-handbook.
- How should things be displayed in the online template handbook? (Drop down labelled options?) Or should those even be deployed?