Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create consistent our-handbook style + instructions for contributors #28

Open
6 tasks
NatalieZelenka opened this issue Oct 4, 2021 · 3 comments
Open
6 tasks

Comments

@NatalieZelenka
Copy link
Collaborator

NatalieZelenka commented Oct 4, 2021

  • Decide how to leave instructions for users of the handbook
    • @jatonline thought that we could use jb admonitions ("hints")
    • @NatalieThurlby was currently using html comments
    • Add this to contribution instructions
    • Figure out how they should be cleaned up
      • a script that will "tidy/clean" the template
      • CSS to make certain elements not render online - perhaps only added at the end
  • Consistent wording of manager/PI/Group leader and team member/group member/student/etc
  • How opinionated should the handbook be?
    • Provide different options where possible
  • The handbook isn't a tutorial for things that are explained well elsewhere (e.g. Open Science), but it's a place where group leaders can make commitments about how they are going to run things (until they review them next). The template is a place where people can see the menu of different ways to run a group, and make a decision to choose something.
@jatonline
Copy link
Collaborator

Some ideas... It would be good to have a unified way of leaving 'notes' or guidance folks filling in the template handbook.

Use cases:

  • It might be the first time they're filling in the template and they need some inspiration
  • They might be revisiting a page after some time and would still find the notes helpful
  • They might be working with a non-technical colleague that doesn't understand Markdown/MyST and so it would be helpful to render the notes in the built version of the book, so the colleague can help
  • But it would be good if the notes could be switched off or hidden somehow, when the template is completed

@lauren-cadwallader
Copy link
Contributor

I think it would be useful to have different types of instructions/hints so some are like "you need to do this" (a direct instruction) and others are like "you might be able to find this information from your Research Office" (a hint to make things better/easier).

@NatalieZelenka NatalieZelenka changed the title Decide how to leave instructions for template users Create consistent our-handbook style + instructions Oct 4, 2021
@jatonline
Copy link
Collaborator

Where we have separate instructions for authors editing the handbook in their web browser or on their local machine, we could also suggest the use of tabs to split each set of instructions (see #53)

@jatonline jatonline changed the title Create consistent our-handbook style + instructions Create consistent our-handbook style + instructions for contributors Oct 6, 2021
This was referenced Oct 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants