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

docs(content): general content updates as usual


I'll do the changelog stuff, but at least we have
the About Handbook page then.

Signed-off-by: default avatarAndrei Jiroh Halili <ajhalili2006@andreijiroh.eu.org>
parent 2b6a7516
No related branches found
No related tags found
No related merge requests found
......@@ -5,6 +5,10 @@
# keybase proofs
/keybase.txt /.well-known/keybase.txt
/security.txt https://recaptime.eu.org/.well-known/security.txt
/.well-known/security.txt https://recaptime.eu.org/.well-known/security.txt
# quick golinks
/go/internal-handbook-docs /handbook/handbook-usage#internal-handbook
\ No newline at end of file
/go/internal-handbook /handbook/handbook-usage#internal-handbook
/go/onboarding /handbook/company/general-onboarding.md
/go/coc https://policies.recaptime.eu.org/coc
\ No newline at end of file
# About the handbook
## History of the handbook
> 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
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/)
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.
Most parts of the handbook are adopted from the [GitLab Handbook](https://handbook.gitlab.com), licensed under MIT.
## Handbook Interpretation
The handbook is subject to interpretation. We do our best to be as clear as possible to minimize confusion and/or misinterpretation. We also recognize that we have a global audience and that may bring different interpretations. If you have any questions or need further clarification please check with the content owner of the page. When in doubt please reach out and ask.
**Remember that [everything is in draft](./values.md#everything-is-in-draft) at Recap Time Squad and subject to change, this includes our handbook.**
## More about the handbook
* [How to use](../handbook-usage.md)
* [Getting handbook support](./support.md)
# Handbook Support
## Where to send patches?
**On GitHub**: Our Git mirror for the wiki is linked to [Netlify](https://app.netlify.com/sites/recaptime-squad-wiki/overview), so you can send a merge request there and expect the CI to catch up there.
**On GitLab**: We'll be doing some CI/CD work to make deploys work on Netlify without upgrading to Enterprise plan (yet).
title: Handbook changelog
description: Tune in to the changes happening on the squad handbook.
---
# Handbook changelog
Welcome to the changelog! We'll log merge requests, significant/major, and other
important changes to the handbook.
## Unreleased - `dock.mau.dev/recaptime-dev/squad/wiki/offline-view:latest`
Since we're working on migrating stuff from Miraheze, among other things, we apologize for outdated changelog entries here.
......@@ -17,6 +17,10 @@ what we do in DIB (Diversity, Inclusion and Belonging).
* `#recaptimesquad-staff-it_support` - Any IT related support, such as issues with your squad email address, SSO, etc.
* `#recaptimesquad-staff-watercooler` - General chitchat for squad members.
### Bridge mappings to other apps
!!!
## Managers of New Crewmates
TODO
# Recap Time Squad Handbook Usage
Most of the content here are adopted from [GitLab Handbook Usage](https://handbook.gitlab.com/handbook/handbook-usage/)
## Flow structure
* A (process) problem comes up, frequently in an issue or chat.
* A proposal is made in a merge request to the handbook.
* Once merged, the change is announced by linking to the diff in the MR or commit.
* Major ones are posted in the #recaptimesquad-internal-news channel.
* Medium ones are posted in the #recaptimesquad-internal-handbook channel for visibility, with a one line summary of the change.
* If there was an issue, close it out with a link to the diff.
Sometimes you want to have real time editing of a proposal during a meeting and you need to use a Google Doc for that. When doing so the first item should be the URL of the handbook page this content will be moved to when the meeting is over.
## Staging Wiki
We do host an fork of the squad wiki over at [JetBrains Space](https://recaptime.jetbrains.space/p/wiki-staging).
## Internal Wiki
Instead of pulling an MediaWiki setup, we settle with Wiki.js with pages being written in Markdown, alongside some Wiki.js-specific syntax[^1].
[^1]: https://docs.requarks.io/editors/markdown
## Why build with Mkdocs instead of using MediaWiki?
From the GitLab handbook:
> Company handbooks [frequently start as wikis](https://about.gitlab.com/company/culture/all-remote/handbook-first-documentation/#tools-for-building-a-handbook). This format is more comfortable for people to work in than a static website with GitLab Merge Requests and GitLab Pages. However wikis tend to go stale over time, where they are badly organized and get out of date.
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