|
1 | | -# Welcome! |
| 1 | +# Welcome! {.unnumbered} |
| 2 | + |
| 3 | +::: callout-caution |
| 4 | +These documents are very much a work in progress and very much |
| 5 | +incomplete. We work on it slowly and when we can. |
| 6 | +::: |
2 | 7 |
|
3 | 8 | {{< include /includes/_badges.qmd >}} |
4 | 9 |
|
5 | | -Guidebook is about... |
| 10 | +This guidebook walks you through how we, in the [Seedcase |
| 11 | +Project](https://seedcase-project.org/), develop and release research |
| 12 | +software, build data infrastructures, create content on websites, and |
| 13 | +work together as a team. We've written this to collect best practices |
| 14 | +and lessons learned as we've built products as a team. |
| 15 | + |
| 16 | +We cover topics that range from our contribution workflow, how we write |
| 17 | +code, how we ensure our products are secure and reliable, how we |
| 18 | +collaborate and manage our work, and more. |
6 | 19 |
|
7 | 20 | ## Who you are as the reader |
8 | 21 |
|
9 | 22 | We've written these documents considering a few people in mind who we |
10 | 23 | think will read the documents: |
11 | 24 |
|
12 | | -- **New contributors/team members**: ... |
13 | | -- **Research software/data engineers**: ... |
14 | | -- **Managers or leaders**: ... |
15 | | -- **Research or development operations personnel**: ... |
| 25 | +- **New contributors/team members**: This is who we are primarily |
| 26 | + writing for. If you are new to working with us on the Seedcase |
| 27 | + Project, these documents are designed with you in mind. |
| 28 | +- **Research software/data engineers**: If you work in another |
| 29 | + organization or group, we write these documents to share our |
| 30 | + practices with you. You can use this either as a guide or as a |
| 31 | + reference to help you improve and learn how we work. |
| 32 | +- **Managers or leaders**: If you are in a position where you have |
| 33 | + control or power to influence how work is done and organised, these |
| 34 | + documents can serve as inspiration for how to structure teams, |
| 35 | + workflows, and practices to build products more effectively, |
| 36 | + reliably, and securely. |
| 37 | +- **Research or development operations personnel**: For those who are |
| 38 | + responsible for maintaining infrastructure or operational aspects of |
| 39 | + a research organisation, these documents can provide insights into |
| 40 | + best practices for managing and deploying research software and data |
| 41 | + systems in an effective way that hopefully reduces your workload. |
16 | 42 |
|
17 | 43 | ## Contributing |
18 | 44 |
|
|
0 commit comments