summaryrefslogtreecommitdiff
path: root/README.md
blob: 28443073d298996697d3e987fc6de8d17622c55f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
This repository contains information about Parabola contributors.

It previously contains programs for working with that information;
they now live at [parabola-hackers][], and programs for use with
`git-shell`; they now live at
[git-meta.git/git-shell-commands][git-shell-commands].

[parabola-hackers]: https://git.parabola.nu/packages/parabola-hackers.git/
[git-shell-commands]: https://git.parabola.nu/git-meta.git/tree/git-shell-commands

Adding users
============

Users ("hackers") are added by creating a file in the `users/`
directory.  The file should be named `users/${UID}.yml` where UID is
the numeric POSIX user ID for that user.  See [meta-normalize-stdio][]
(part of the `parabola-hackers` package) for a listing of all the
properties you can put in the users file; or look at the existing
files as examples.

[meta-normalize-stdio]: https://git.parabola.nu/packages/parabola-hackers.git/tree/bin/meta-normalize-stdio

*NOTICE* Before pushing, please run `meta-check` to verify that the
 syntax is correct.  If you push YAML files with incorrect syntax, you
 may break all normal SSH access to the servers, and then one of the
 emergency operators will have to fix it.  (We should probably add a
 server hook to reject pushes that break it huh?  I'll get to that
 eventually...).  Run `meta-check` by installing the
 `parabola-hackers` package and running

    PARABOLA_HACKERS_YAMLDIR=/path/to/hackers/users /lib/parabola-hackers/meta-check

To add a profile image of a user, add it to the `dev-imgs/` folder.

Images in `dev-imgs/`:
 - MUST be named `${username}.png`
 - SHOULD be 125x125 px
 - SHOULD be run through pngcrush

Doing things with the documentation
===================================

The `parabola-hackers` package contains several programs for doing
things with the data in this repository.  You should install it.

For fuller documentation, see the README of [parabola-hackers][].
But, here some simple commands that you are likely interested in.

Firstly, before using any of these commands, you need to tell them
where to find the files:

	export PARABOLA_HACKERS_YAMLDIR=/path/to/hackers-git/users
	
where `/path/to/hackers-git` is the directory containing this README
file.  Alternatively, you may set `yamldir` in
`/etc/parabola-hackers.yml` (the environment variable takes precedence
over the config file).

Check the integrity and formatting of the files:

    /usr/lib/parabola-hackers/meta-check
	
PLEASE, PLEASE, OH PLEASE: run the above command before committing to
this repository.

Create a tarball to be the source of the parabola-keyring package:

    /usr/lib/parabola-hackers/pacman-make-keyring V=$(date -u +%Y%m%d)