8887655aa821f59cb4851f3883905a0c71b05370 - hscloud

commit	8887655aa821f59cb4851f3883905a0c71b05370	[log] [tgz]
author	Serge Bazanski <q3k@hackerspace.pl>	Sun Aug 16 15:24:58 2020 +0200
committer	q3k <q3k@hackerspace.pl>	Sun Aug 16 13:25:40 2020 +0000
tree	10df5b9c8d01d35753da84c26cec17d70c0bab67
parent	b97a303f89c5e96d26fa2694b798de1acf02f14c [diff]

tree: 10df5b9c8d01d35753da84c26cec17d70c0bab67

README.md

hscloud is the main monorepo of the Warsaw Hackerspace infrastructure code.

Any time you see a //path/like/this, it refers to the root of hscloud, ie. the path path/like/this in this repository. Perforce and/or Bazel users should feel right at home.

Viewing this documentation

For a pleaseant web viewing experience, see this documentation in hackdoc. This will allow you to read this markdown file (and others) in a pretty, linkable view.

Getting started

See //doc/codelabs for tutorials on how to use hscloud.

If you want to browse the source of hscloud in a web browser, use cs.hackerspace.pl.

If you want some other help, talk to q3k, informatic or your therapist.

Directory Structure

Directories you should care about:

app: external services that we host that are somewhat universal: matrix, covid-formity, etc.
bgpwtf: code related to our little ISP
cluster: code related to our Kubernetes cluster (k0.hswaw.net)
dc: code related to datacenter automation
devtools: code related to developer tooling, like gerrit or hackdoc
doc: high-level documentation that doesn't fit anywhere else, ie. codelabs
hswaw: Warsaw Hackerspace specific/internal services. The line between this and app is unfortunately blurry.
personal: user's personal (experimental) directories
kube, go: code specific to languages but general to the whole of hscloud

Licensing

Unless noted otherwise, code in hscloud is licensed under the BSD 0-clause license - see COPYING.