cheshire
/
hscloud
forked from hswaw/hscloud
1
0
Fork 0
Code Pull Requests Activity
hscloud/README.md

36 lines
1.4 KiB
Markdown
Raw Normal View History

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 checkout. The code is incomplete, and is WIP. Change-Id: I68ef7a991191c1bb1b0fdd2a8d8353aba642e28f
2020-04-08 18:03:12 +00:00
hscloud
=======
`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
--------------------------
devtools/{depotview,hackdoc}: tie both together Change-Id: I0a1ca3b4fa0e0a074eccbe0f8748839b926db9c1
2020-04-10 15:39:43 +00:00
For a pleaseant web viewing experience, [see this documentation in hackdoc](https://hackdoc.hackerspace.pl/). This will allow you to read this markdown file (and others) in a pretty, linkable view.
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 checkout. The code is incomplete, and is WIP. Change-Id: I68ef7a991191c1bb1b0fdd2a8d8353aba642e28f
2020-04-08 18:03:12 +00:00
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?
---------
Revert "*: update docs for hackdoc" This reverts commit cc8c69c8974f7ce415641121cedb01d7e6aa9e17. Reason for revert: <INSERT REASONING HERE> Change-Id: I1315e930e2ef69db3188eda05e4aa0b12db24274
2020-04-10 20:09:35 +00:00
If you want to use our Kubernetes cluster to run some stuff, see [//cluster/doc/user](cluster/doc/user).
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 checkout. The code is incomplete, and is WIP. Change-Id: I68ef7a991191c1bb1b0fdd2a8d8353aba642e28f
2020-04-08 18:03:12 +00:00
Revert "*: update docs for hackdoc" This reverts commit cc8c69c8974f7ce415641121cedb01d7e6aa9e17. Reason for revert: <INSERT REASONING HERE> Change-Id: I1315e930e2ef69db3188eda05e4aa0b12db24274
2020-04-10 20:09:35 +00:00
If you're looking for administrative docs about cluster maintenance, see [//cluster/doc/admin](cluster/doc/admin).
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 checkout. The code is incomplete, and is WIP. Change-Id: I68ef7a991191c1bb1b0fdd2a8d8353aba642e28f
2020-04-08 18:03:12 +00:00
If you want to browse the source of `hscloud` in a web browser, use [gerrit's gitiles](https://gerrit.hackerspace.pl/plugins/gitiles/hscloud/+/refs/heads/master/).
If you want to learn how to contribute to this repository, see [//doc/codelab/gerrit](doc/codelab/gerrit).