Fork 0
Go to file
q3k c881cf3c22 devtools/hackdoc: init
This is hackdoc, a documentation rendering tool for monorepos.

This is the first code iteration, that can only serve from a local git

The code is incomplete, and is WIP.

Change-Id: I68ef7a991191c1bb1b0fdd2a8d8353aba642e28f
2020-04-08 20:03:12 +02:00
app app/covid-formity: covid19 hackerspace relief form 2020-03-26 21:40:01 +01:00
bgpwtf bgpwtf/invoice: bump for 2020 2020-01-14 14:03:38 +01:00
bzl go/{mirko,statusz}: better status, kubernetes client 2019-07-21 23:54:41 +02:00
cluster devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
dc dc/arista-proxy: fix by using github.com/q3k/cursedjson 2019-09-26 18:32:39 +02:00
devtools devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
gcp secretstore: add implr 2019-05-18 00:15:25 +02:00
go go/{mirko,statusz}: enable profiling 2020-01-23 14:17:30 +01:00
hswaw hswaw/kube: encrypt keys, update expired keys 2020-02-18 23:28:14 +01:00
kube hswaw/kube: add pretalx 2020-02-18 22:56:21 +01:00
personal/q3k personal/q3k/factorio: add pymods server 2020-04-05 21:32:02 +02:00
third_party k8s.io/apimachinery: bypass https://github.com/kubernetes/kubernetes/issues/87675 2020-02-21 12:54:05 +01:00
tools hswaw/kube: encrypt keys, update expired keys 2020-02-18 23:28:14 +01:00
.bazelrc smsgw: productionize, implement kube/mirko 2019-10-04 13:52:34 +02:00
.gitignore bgpwtf/cccampix/pgpencryptor: add service base 2019-08-10 10:51:07 -07:00
BUILD *: move away from python_rules 2019-07-16 22:22:05 +00:00
COPYING isc license 2018-10-25 14:25:36 +02:00
README.md devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
WORKSPACE devtools/hackdoc: init 2020-04-08 20:03:12 +02:00
env.fish env.fish: add 2020-02-15 01:22:58 +01:00
env.sh env: fix missing hscloud_nixos export 2020-03-21 23:44:10 +01:00
hackdoc.toml devtools/hackdoc: init 2020-04-08 20:03:12 +02:00



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 please 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

You will need Bash and Bazel (1.2.0+). Clone this repo, cd into it and:

. ./env.sh       # setup PATH and hscloud_root
tools/install.sh # build tools

A bunch of common tools will appearify in your $PATH. You should now be ready to follow other documentation.

This does not pollute your system, and you can work on multiple hscloud checkouts independently.

What now?

If you want to use our Kubernetes cluster to run some stuff, see //cluster/doc/user.

If you're looking for administrative docs about cluster maintenance, see //cluster/doc/admin.

If you want to browse the source of hscloud in a web browser, use gerrit's gitiles.

If you want to learn how to contribute to this repository, see //doc/codelab/gerrit.