Skip to content
Snippets Groups Projects
Commit 8195601d authored by Andrei Jiroh Eugenio Halili's avatar Andrei Jiroh Eugenio Halili :school:
Browse files

docs(content): document onboarding process a bit


Also updated the bloody README with some badges and edits.

Signed-off-by: default avatarAndrei Jiroh Halili <ajhalili2006@andreijiroh.eu.org>
parent 8b057fc0
No related branches found
No related tags found
No related merge requests found
# This content is migrated to the wiki
Please see <https://squad.lorebooks.eu.org/contribute> for instructions on how to contribute.
# Recap Time Squad Wiki
[![Netlify Status](https://api.netlify.com/api/v1/badges/4b0bbe53-ba71-407d-bd17-601a8acaad9a/deploy-status?branch=main)](https://app.netlify.com/sites/recaptime-squad-wiki/deploys)
[![Inspired by GitLab](https://img.shields.io/badge/Inspired%20by%20GitLab-7759C2?style=for-the-badge&logo=gitlab)](https://handbook.gitlab.com/handbook/inspired-by-gitlab/)
[![Part of Lorebooks.wiki](https://img.shields.io/badge/Part%20of%20lorebooks.wiki%20project-white?style=for-the-badge&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI%2BPHBhdGggZD0iTTIxLDRIM0EyLDIgMCAwLDAgMSw2VjE5QTIsMiAwIDAsMCAzLDIxSDIxQTIsMiAwIDAsMCAyMywxOVY2QTIsMiAwIDAsMCAyMSw0TTMsMTlWNkgxMVYxOUgzTTIxLDE5SDEzVjZIMjFWMTlNMTQsOS41SDIwVjExSDE0VjkuNU0xNCwxMkgyMFYxMy41SDE0VjEyTTE0LDE0LjVIMjBWMTZIMTRWMTQuNVoiIC8%2BPC9zdmc%2B&logoColor=white)](https://lorebooks.eu.org)
The new home for squad's organizational wiki and the handbook itself. If you're a squad member and you need the internal version, [sign in here](https://internal.squad.lorebooks.eu.org) or [learn more in handbook](https://squad.lorebooks.eu.org/go/internal-handbook-docs).
The new home for squad's organizational wiki and the handbook itself, built with [Material theme for Mkdocs](https://material-theme.mkdocs.lorebooks.eu.org)[^3].
[^3]: That's just a project wiki redirect for `mkdocs-material` PyPi package on our side, will be enabled soon.
If you're a squad member (or someone who get allowlisted for access) and you need the internal version, [sign in here](https://internal.squad.lorebooks.eu.org) or [learn more in handbook](https://squad.lorebooks.eu.org/go/internal-handbook).
## Where it's been deployed
We use Netlify to host stuff, although we use GitLab CI to do the deployment itself.
The website is accessible at [`squad.lorebooks.eu.org`](https://squad.lorebooks.eu.org) while we're ironing out
The website is accessible at [`squad.lorebooks.eu.org`](https://squad.lorebooks.eu.org) [^2] while we're ironing out
the migration plan until further notice.[^1]
## Contributing to thr wiki
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details. By submitting patches, you agree to the Community Code of Conduct and Linux DCO.
[^1]: We'll be working on the deployments itself soonish.
[^2]: if you'r coming from `wiki.recaptime.eu.org`, you should be autoredirected behind the scenes.
# Contributing to the wiki
This Markdown wiki is built with Material for Mkdocs, so basic knowledge of Markdown syntax, alongside some theme-specifics are required.
## Patching the handbook?
TBD
# About the handbook
## History of the handbook
Our team handbook is where we document processes, functions and everything in between.
> Well actually, we did a full blown wiki instead of just the team handbook. The last thing you worry about experiencing (autistic) burnout is the succession plan. - @ajhalili2006
## History of the handbook
Since Recap Time Squad is currently an one-man operation (and obviously not a company), it is important for ~ajhalili2006 (our [SABDFL(../)]) to have everything about the squad being documented in case of [being hit by a bus](https://www.michaelbromley.co.uk/blog/but-what-about-the-bus-factor/)
Since Recap Time Squad is currently an one-man operation (and obviously not a company), it is important for ~ajhalili2006 (our [SABDFL](../sabdfl.md)) to have everything about the squad being documented in case of [being hit by a bus](https://www.michaelbromley.co.uk/blog/but-what-about-the-bus-factor/)
or (hopefully this don't happen but that's the worst case scenario) [die by suicide (as a high risk individual)](https://www.spectrumnews.org/features/deep-dive/hidden-danger-suicide-autism/).[^1]
[^1]: That's depressing for some, but as an neurodivergent person, it's a unholy mess of trauma and mental health issues.
[^1]: That's depressing for some, but as an neurodivergent/autistic person, it's a unholy mess of trauma and mental health issues over the years.
Most parts of the handbook are adopted from the [GitLab Handbook](https://handbook.gitlab.com), licensed under MIT.
Most parts of the handbook are adopted from the [GitLab Handbook](https://handbook.gitlab.com), licensed under the same license as the one we use for wiki content and adopted for the squad.
## Handbook Interpretation
......@@ -19,5 +19,6 @@ The handbook is subject to interpretation. We do our best to be as clear as poss
## More about the handbook
* [How to use](../handbook-usage.md)
* [How to use](../handbook-usage.md) for crew and general public
* [Getting handbook support](./support.md)
* [Why GitLab](../open-source/gitlab.md) - rationale why we use GitLab primarily
# Onboarding Checklist at Recap Time Squad
!!! info "Adopted from Homebrew's new maintainer checklist"
**Existing squad members and leadership team uses this guide to
invite and onboard new maintainers and project leaders.**
## Open-source maintainer
There's someone who has been making consistently high-quality contributions to
Recap Time Squad and shown themselves able to make slightly more advanced
contributions than just e.g. bug fixes and docs? Let's invite them to be a community maintainer!
!!! note "Replace placeholders with real values"
The template below is customizable, so fellow maintainers/squad members should edit it as needed.
```markdown
The Recap Time Squad members and I really appreciate your help on issues, pull requests and
your contributions to $PROJECT_NAME.
We would like to invite you to have commit access and be a community maintainer.
If you agree to be a maintainer, you should spend a significant proportion of
the time you are working on Homebrew applying and self-merging widely used
changes (e.g. version updates), triaging, fixing and debugging user-reported
issues, or reviewing user pull requests. You should also be making contributions
to $PROJECT_NAME at least once per quarter.
You should watch or regularly check <project-name-repo-urls> [and/or <add more here>].
Let us know which so we can grant you commit access appropriately.
If you're no longer able to perform all of these tasks, please continue to
contribute to $PROJECT_NAME, but we will ask you to step down as a maintainer.
A few requests:
- Please make pull requests for any changes in the $PROJECT_NAME repositories (instead
of committing directly) and don't merge them unless you get at least one approval
and passing tests.
- Please review the Maintainer Guidelines at https://handbook.recaptime.eu.org/go/oss-maintainer-guidelines
- Please review the team-specific guides for whichever teams you will be a part of.
Here are links to these guides:
- Link to maintainer guides specific to project
- Continue to create branches on your fork rather than in the main repository.
Note GitHub/GitLab's UI will create edits and reverts on the main repository if you
make edits or click "Revert" on the Homebrew/brew repository rather than your
own fork.
- If still in doubt please ask for help and we'll help you out.
- Please read:
- handbook.recaptime.eu.org/go/oss-maintainer-guidelines
- the team-specific guides linked above and in the maintainer guidelines
- anything else you haven't read on $PROJECT_DOCS and https://handbook.recaptime.eu.org
How does that sound?
Thanks for all your work so far!
```
If they accept, follow a few steps to get them set up:
* Add them to [`@recaptime-dev/maintainers` GitLab subgroup on mau.dev](https://mau.dev/recaptime-dev/maintainers/-/group_members) and on [GitHub](https://github.com/orgs/recaptime-dev/teams/maintainers) and any subteams as needed
* If the project is on seperate namespace, check :
* @awesome-neurodiversity/maintainers
* github:@lorebooks-wiki/maintainers
* @gitpodify/maintainers
* Ask them to disable SMS as a 2FA device or fallback on their GitHub account in favour of using one of the other authentication methods.
* Start the process to add them as [@recaptime-dev/squad members](#squad-member), for formal voting rights and the ability to hold office for Homebrew.
## Squad member
Being part of `@recaptime-dev/squad` is way more involved than just maintaining open-source projects,
depending on where department they fall.
If they are interested in doing ops/infrastructure/system administration work:
* If operations and infra, onboard them to DevOps/Platform Engineering subteam of Engineering and Open-source Department
* If system adminstration
If they are interested in doing legal/finanicals/human resources:
* [Onboard them to Legal and HR Department.](../legal/onboarding.md)
......@@ -4,11 +4,16 @@ title: General Onboarding
# Onboarding at Recap Time Squad
Welcome aboard to the squad, newbie! Since our organization is mostly "all remote" and our virtual headquarters is in our Matrix space for staff
(`#internal.recaptime.dev:envs.net`)
([`#internal.recaptime.dev:envs.net`](https://matrix.to/#/#internal.recaptime.dev:envs.net?via=envs.net))
## For crew, maintainers and contributors - Checklist
We have an onboarding checklist
## Channel Support for new crewmates
Once your Matrix account is fully onboarded to our staff-only space, you should receive invites to these rooms from day 1 from your manager or one of our squad leaders:
Once your Matrix account is fully onboarded to our staff-only space, you should receive invites to these rooms from day 1 from your manager
or one of our squad leaders:
* `#recaptimesquad-staff-intro` - Go say hi and introduce yourself.
* `#recaptimesquad-staff-questions` - Ask questions that the Handbook can't help with or if need clarifications.
......@@ -19,8 +24,10 @@ what we do in DIB (Diversity, Inclusion and Belonging).
### Bridge mappings to other apps
!!!
!!! note "Working in it"
## Managers of New Crewmates
TODO
Until we have a proper Squad Leadership and other teams, @ajhalili2006 will be
your manager corporate speaking if the legal entity for holding funds (and other legalese)
exist, but otherwise
......@@ -16,6 +16,7 @@ of [the Community Lores project][project-meta], the documentation and wiki depar
Follow the crew at [our socials](/community/socials) for updates and more.
* **August 2023**: Our website got revamped! [See this post for details.](https://recaptime.eu.org/2023/08/10/hello-world/)
* **July 2023**: We're a bit worried about Miraheze's future, but we're still monitoring the situation. In the meanwhile, we're moving our wiki into Markdown as a backup. [Follow this issue](https://mau.dev/RecapTime/squad/issue-tracker/-/issues/7) for updates.
_For archived news (more than 12 months OR when the entries go more than 5-10) please see the [news archive](./community/news-archive.md)._
......@@ -32,7 +33,7 @@ _For archived news (more than 12 months OR when the entries go more than 5-10) p
Like most of the projects we do, our public organizational wiki is open to anyone to improve upon. Since
* [Contributing](contribute/index.md) - learn how you can use your knowledge, skills and time to help us maintain
* [Contributing](./contribute/index.md) - learn how you can use your knowledge, skills and time to help us maintain
projects and keep things tidy.
* [Donate](./community/donate.md) - A record of previous purchases and costs are publicly releases here,
alongside on Open Collective.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment