add rtm-astro-recipe as a submodule, along with instructions on how to use submodules

2026-04-26 12:41:12 -07:00
parent 7965eb9ccc
commit a87191b573
3 changed files with 38 additions and 0 deletions
@@ -0,0 +1,3 @@
+[submodule "abra/recipes/rtm-astro-recipe"]
+	path = abra/recipes/rtm-astro-recipe
+	url = https://git.coopcloud.tech/RTM/rtm-astro-recipe
@@ -0,0 +1,34 @@
+## Usage
+
+Members of RTM: check out the "RTM Reference" collective on our nextcloud for information on how to set up tailscale, ssh access, and user accounts on our servers. Without this, you won't be able to do operations.
+
+```
+$ git clone --recurse-submodules https://git.coopcloud.tech/RTM/rtm-config.git
+$ cd rtm-config
+$ abra server add laylotta.resisttechmonopolies.online
+$ abra server add mango.resisttechmonmopolies.online
+$ abra server add sootie.resisttechmonopolies.online
+```
+
+If you skipped the `--recurse-submodules` flag, you can still do `git submodule update --init` later.
+
+The submodule is our [`rtm-astro-recipe`](https://git.coopcloud.tech/RTM/rtm-astro-recipe) for convenience in developing it.
+
+From here, use `abra` to make changes (and reach out to a member of our infra/member-services working group for a tutorial if you would like!). Then, contribute your git changes back to this repository so everyone else sees what you've done and doesn't clobber your changes.
+
+### RTM website specifics
+
+The recipe for the RTM website is its own git submodule. Git submodules are the way to include a git repo within another git repo. There are some gotchas when working with submodules you'll want to be aware of. Namely, you'll have to update the rtm-astro-recipe submodule and the rtm-config repo separately. You can run `git submodule update` to fetch changes to the website.
+
+https://git-scm.com/book/en/v2/Git-Tools-Submodules for more info on submodules.
+
+In practice if you would like to make changes to the RTM website,
+
+1. Make changes to the `rtm-astro-recipe` submodule
+2. Test changes by deploying to `dev.resisttechmonopolies.online`, hosted on sootie
+3. If everything looks good, deploy the changes to `resisttechmonopolies.online`!
+4. Since the `rtm-astro-recipe` submodule is its own git repository, commit your website changes in the `rtm-astro-recipe` submodule and contribute them back, and if neccessary also make a commit in the `rtm-config` repo to contribute it back
+
+## Dev environment
+
+Sootie is our dev server. If you would like to experiment with changes and fuck around there, use sootie! The implication here is that sootie has a greater chance of having uncommitted changes in its environment than other servers, and that these changes are safe to clobber over.