From b3bac42cc28b0a303db3442885f033503414eb7b Mon Sep 17 00:00:00 2001 From: cellarspoon Date: Thu, 27 Jan 2022 11:04:53 +0100 Subject: [PATCH] more more more --- docs/maintainers/handbook.md | 47 +++++++++++++++++++ docs/maintainers/index.md | 5 +- docs/operators/index.md | 2 +- docs/organisers/{schedules.md => handbook.md} | 14 +++++- docs/organisers/index.md | 7 ++- mkdocs.yml | 3 +- 6 files changed, 73 insertions(+), 5 deletions(-) create mode 100644 docs/maintainers/handbook.md rename docs/organisers/{schedules.md => handbook.md} (93%) diff --git a/docs/maintainers/handbook.md b/docs/maintainers/handbook.md new file mode 100644 index 0000000..1bcae57 --- /dev/null +++ b/docs/maintainers/handbook.md @@ -0,0 +1,47 @@ +--- +title: Packaging handbook +--- + +## Create a new recipe + +TODO. + +## Make a new release + +TODO. + +## Generate the recipe catalogue + +TODO. + +## Enable healthchecks + +TODO. + +## Tuning deploy configs + +TODO. + +## Tuning resource limits + +TODO. + +## Enable A+ SSL ratings + +TODO. + +## Thread environment variables + +TODO. + +## Entrypoint hacks + +TODO. + +### Exposing secrets + +TODO. + +### /bin/bash is missing? + +TODO. diff --git a/docs/maintainers/index.md b/docs/maintainers/index.md index e069244..e32dbca 100644 --- a/docs/maintainers/index.md +++ b/docs/maintainers/index.md @@ -2,4 +2,7 @@ title: Maintainers guide --- -TODO. +Welcome to the maintainers guide! Maintainers are typically individuals who have a stake in building up and maintaining our digital configuration commons, the recipe configurations. Maintainers help keep recipes configurations up to date, respond to issues in a timely manner, help new users within the community and recruit new maintainers when possible. + +- [New maintainers tutorial](/maintainers/tutorial): If you want to become a maintainer, start here :rocket: +- [Packaging handbook](/maintainers/handbook): One-stop shop for all you need to know to package recipes :package: diff --git a/docs/operators/index.md b/docs/operators/index.md index e5dea93..19837ea 100644 --- a/docs/operators/index.md +++ b/docs/operators/index.md @@ -2,7 +2,7 @@ title: Operators Guide --- -Welcome to the Operators guide! Operators are individuals, members of tech co-ops or collectives who provide services powered by Co-op Cloud. This documentation is meant to help new & experienced operators manage their deployments as well as provide a space for sharing tricks & tips for keeping things running smoothly. Operators are encouraged to submit documentation patches! Sharing is caring :sparkling_heart: +Welcome to the operators guide! Operators are typically individuals, members of tech co-ops or collectives who provide services powered by Co-op Cloud. This documentation is meant to help new & experienced operators manage their deployments as well as provide a space for sharing tricks & tips for keeping things running smoothly. Operators are encouraged to submit documentation patches! Sharing is caring :sparkling_heart: - [New operators tutorial](/operators/tutorial): If you want to become an operator, start here :rocket: - [Operations handbook](/operators/handbook): One-stop shop for all you need to know to manage a deployment :ribbon: diff --git a/docs/organisers/schedules.md b/docs/organisers/handbook.md similarity index 93% rename from docs/organisers/schedules.md rename to docs/organisers/handbook.md index 9e4a022..2810df9 100644 --- a/docs/organisers/schedules.md +++ b/docs/organisers/handbook.md @@ -1,7 +1,19 @@ --- -title: Schedules +title: Organising handbook --- +## Onboarding new operators + +TODO. + +## Onboarding new maintainers + +TODO. + +## Gathering new case studies + +TODO. + ## Monthly updates We have decided we'll try to do monthly progress updates. These will be published on the Co-op Cloud blog. It's a pretty loose format and we're basically just copy/pasta'ing things to a public pad during the month: ["This month in Co-op Cloud"](https://pad.autonomic.zone/YHKn4vHORmS6wjN1t2zi5A?both). Feel free to add your items to the monthly agenda and they will be included! All the previous posts can be seen [here](https://coopcloud.tech/blog/). diff --git a/docs/organisers/index.md b/docs/organisers/index.md index 2ad2718..125b0c9 100644 --- a/docs/organisers/index.md +++ b/docs/organisers/index.md @@ -2,4 +2,9 @@ title: Organisers Guide --- -TODO. +> This documentation section is still forming... + +Welcome to the organisers guide! + +- [New organisers tutorial](/oragnisers/tutorial): If you want to become an organiser, start here :rocket: +- [Organising handbook](/organisers/handbook): One-stop shop for all you need to know to organise in the community :sparkles: diff --git a/mkdocs.yml b/mkdocs.yml index 128a372..9c18cba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,10 +52,11 @@ nav: - "Maintainers Guide": - maintainers/index.md - "New maintainers tutorial": maintainers/tutorial.md + - "Packaging handbook": maintainers/handbook.md - "Organisers Guide": - organisers/index.md - "New organisers tutorial": organisers/tutorial.md - - "Schedules": organisers/schedules.md + - "Organising handbook": organisers/handbook.md - "Recipes": recipes/index.md - "Abra": - abra/index.md