Skip to content

Commit 2fa47a6

Browse files
authored
chore: prettify README.md
1 parent 71bb6a0 commit 2fa47a6

File tree

1 file changed

+32
-15
lines changed

1 file changed

+32
-15
lines changed

README.md

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,56 @@
22

33
**MX server management for iojs.org**
44

5-
65
## Server
76

8-
[Mailgun](http://www.mailgun.com/) is used to route email from the `iojs.org` domain to the aliases described in this repo.
9-
7+
[Mailgun](http://www.mailgun.com/) is used to route email from the `iojs.org`
8+
domain to the aliases described in this repo.
109

1110
## Email aliases
1211

13-
The [iojs.org](./iojs.org) directory contains the [aliases.json](./iojs.org/aliases.json) file which describes the wanted email aliasing. It is structured as a mapping of `"from"` usernames @iojs.org to `"to"` actual email addresses.
14-
12+
The [iojs.org](./iojs.org) directory contains the
13+
[`aliases.json`](./iojs.org/aliases.json) file which describes the wanted email
14+
aliasing. It is structured as a mapping of `"from"` usernames @iojs.org to
15+
`"to"` actual email addresses.
1516

1617
## Updating
1718

1819
### Responsibility
1920

20-
Since access to the Mailgun API key is required, only members of the @nodejs/build-infra team have the permission to push code to the `main` branch. That was done in order to minimize the possibility of mismatches between the information in this repo, and the actual email routes that are set up.
21+
Since access to the Mailgun API key is required, only members of the
22+
@nodejs/build-infra team have the permission to push code to the `main` branch.
23+
That was done in order to minimize the possibility of mismatches between the
24+
information in this repo, and the actual email routes that are set up.
2125

2226
### Procedure
2327

24-
The [update](./update) directory contains a node program which will read the aliases mapping file, fetch the list of mail routes from Mailgun and update the routes to make sure they match the required state. The program is run by passing it a domain name as an argument (`update/update.js iojs.org`).
28+
The [`update/`](./update) directory contains a node program which will read the
29+
aliases mapping file, fetch the list of mail routes from Mailgun and update the
30+
routes to make sure they match the required state. The program is run by passing
31+
it a domain name as an argument (`update/update.js iojs.org`).
2532

26-
The Mailgun API key for the given domain is required. It can be found in the `admin_logins.md` file in the secrets repo (build/infra/), or directly via the Rackspace API. The key should be stored as a file named `iojs.org/credentials.json` in the form: `{ "api-key": "key-abc..." }` within a code tree.
27-
28-
The programs can be used with `--dry-run` to verify the current status and what will be changed by an update.
33+
The Mailgun API key for the given domain is required. It can be found in the
34+
`admin_logins.md` file in the secrets repo (build/infra/), or directly via the
35+
Rackspace API. The key should be stored as a file named
36+
`iojs.org/credentials.json` in the form: `{ "api-key": "key-abc..." }` within a
37+
code tree.
2938

39+
The programs can be used with `--dry-run` to verify the current status and what
40+
will be changed by an update.
3041

3142
## nodejs.org
3243

33-
`@nodejs.org` email addresses are managed by the Linux Foundation. In order to set one up:
34-
* Create an iojs.org alias with associated recipients as described above.
35-
* Send an email to '[email protected]' requesting that the wanted nodejs.org address by directed to the new alias. Please CC an OpenJS Foundation contact person and provide context as to why the alias is needed.
44+
`@nodejs.org` email addresses are managed by the Linux Foundation. In order to
45+
set one up:
3646

37-
## License & copyright
47+
- Create an iojs.org alias with associated recipients as described above.
48+
- Send an email to <[email protected]> requesting that the wanted
49+
nodejs.org address by directed to the new alias. Please CC an OpenJS
50+
Foundation contact person and provide context as to why the alias is needed.
3851

39-
The contents of this repository are Copyright (c) Node.js Foundation and licensed under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.
52+
## License & copyright
4053

54+
The contents of this repository are Copyright (c) Node.js Foundation and
55+
licensed under the MIT licence. All rights not explicitly granted in the MIT
56+
license are reserved. See the included [`LICENSE.md`](./LICENSE.md) file for
57+
more details.

0 commit comments

Comments
 (0)