README.md

   1 # realraum.at -- Network of Chaos
   2
   3 This repository is hosted on [`git.realraum.at`] and on [Github].
   4 It contains documentation and scripts used for managing the network
   5 in [realraum], an Austrian hackerspace.
   6
   7 The copy on [Github] is (currently) deemed authoritative, to provide
   8 (basic) issues-tracking and PR review tools.  To push to both locations
   9 simultaneously, use the following `.git/config` snippet:
  10
  11         [remote "origin"]
  12                 url = git@git.realraum.at:noc
  13                 url = git@github.com:realraum/noc
  14
  15 In the longer-term, we should setup an internal issues-and-review tool.
  16
  17
  18 [`git.realraum.at`]: https://git.realraum.at/?p=noc.git;a=summary
  19 [Github]:            https://github.com/realraum/noc
  20 [realraum]:          https://realraum.at
  21
  22
  23 ## Development process
  24
  25 There is (currently) no barrier to pushing directly to `master`.  However,
  26 NOC members are welcome to submit pull requests to ask for review/feedback.
  27
  28 Of course, “force-pushing” to `master` is not allowed, whether on
  29 `git.realraum.at` or Github.
  30
  31
  32 ## Documentation
  33
  34 The documentation is located in the `doc/` directory, in a format that
  35 can be rendered by [Ikiwiki], a static site generator.
  36
  37
  38 ## Ansible
  39
  40 Ansible scripts, previously found on `git.realraum.at:ansible`,
  41 are located in the `ansible/` directory.  Documentation related to the
  42 use of Ansible and related scripts is foind there.