Onboarding

[jensdebruijn]

Pull Request Checklist

General Writing Standards

Voice and Clarity

• Text is primarily written in active voice
• Acronyms are written in full at least once on the page where they are used
• We refer to Handbook topics where possible (e.g. to the Handbook page about Yoda instead of some other information page about Yoda)

Links and Referencing

• All links use https:// protocol
• Links are descriptive (avoid "click here" links)
• For pages with a DOI, link through the DOI (e.g., https://doi.org/10.4444/xxxx)

Images

• All images have descriptive alt text

Tone and Style

• Avoid writing in the name of the handbook (no "we recommend")

Topic-Specific Standards

• Topics are nouns or noun phrases
• Topics are self-contained and concise
• Topics are title capitalized
• No include statements in topics
• Only use regular markdown (no special Quarto code)
• Where relevant, assign a suitable category

Guide-Specific Standards

• Guides are phrased as questions the reader will find answers to
• Where relevant, guides are assigned a suitable category

Checklist Usage

• Fill out this checklist when submitting a pull request
• Automated checks will verify some of these standards, but manual review is still crucial

Note to Contributors: Thank you for helping maintain the quality of our handbook!

[netlify]

✅ Deploy Preview for ub-open-handbook ready!

Name	Link
🔨 Latest commit	4a7ed55
🔍 Latest deploy log	https://app.netlify.com/projects/ub-open-handbook/deploys/6891b90395cede00086536be
😎 Deploy Preview	https://deploy-preview-543--ub-open-handbook.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[github-actions]

Summary

Status	Count
🔍 Total	0
✅ Successful	0
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	0
❓ Unknown	0
🚫 Errors	0
Full Github Actions output

[jensdebruijn]

As discussed earlier, we are working on an onboarding guide related to data and software. This is currently a draft alternative for the open handbook. Other parts of the onboarding will be integrated in the onboarding process of the individual faculties.

Note: I didn't assign catagory to this guide because it didn't fit any of the other categories.

[jensdebruijn]

Any ideas or additions are welcome at this stage! Also, I made it a guide now, but please let me know if it better fits as a topic

[github-actions]

Summary

Status	Count
🔍 Total	0
✅ Successful	0
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	0
❓ Unknown	0
🚫 Errors	0
Full Github Actions output

[Jolien-S]

Hi @jensdebruijn,

Thanks for opening up this PR. I think it's a good idea to have a guide addressing onboarding. I think that a guide is indeed the best format. Once more faculty-/department-specific information is available online, I think it would be nice to refer to those (will need regular maintenance!).

I'm curious what @Elisa-on-GitHub and @peer35 think.

I don't have time at the moment to review the content in detail, but we can do that at a later stage.

[jensdebruijn]

Great! I think it is sufficient to know this is in the right direction. We have a meeting with some people working on onboarding soon and then we will align materials from several sources. I will then make an update and request a formal review.