@@ -3,17 +3,31 @@ The Raft Consensus Algorithm
3
3
4
4
This is the repo for Raft website: https://raft.github.io
5
5
6
- Please contribute to the website by submitting pull requests or creating
7
- issues.
6
+ Please contribute to the website by submitting pull requests (preferably) or
7
+ creating issues. The most common way people contribute is by adding a new
8
+ implementation to ` implementations.json ` . Note that the file is ordered
9
+ lexicographically by GitHub repo URL, and this is strictly enforced by automated
10
+ checks.
8
11
9
- The website is hosted as a GitHub static page. To run it locally, start a local
10
- static webserver:
12
+ When you submit a PR, ` ./check.py ` will make sure the data is well-formed. If
13
+ you want to run it locally, you'll need the
14
+ [ ` jsonschema ` ] ( https://pypi.org/project/jsonschema/ ) library first:
15
+ ```
16
+ pip3 install jsonschema
17
+ ```
18
+
19
+ The website is hosted as a GitHub static page at < https://raft.github.io > . To
20
+ run it locally, start a local static webserver:
11
21
```
12
22
python3 -m http.server 8000 --bind localhost
13
23
```
14
24
and open < http://localhost:8080/ > . The server is needed to allow ` index.html ` to
15
25
pull down ` implementations.json ` .
16
26
27
+ The implementations are sorted on the website according to GitHub stars and last
28
+ update time. This information is cached on a separate server a few times a day,
29
+ so new implementations will initially appear at the bottom of the table for a
30
+ few hours.
17
31
18
32
This work is licensed under a Creative Commons Attribution 3.0 Unported License.
19
33
See http://creativecommons.org/licenses/by/3.0/deed.en_US for details.
0 commit comments