1
1
Since releasing new versions is currently a somewhat complicated task, the current procedure
2
- (27.04 .2018) will be outlined in this document.
2
+ (12.05 .2018) will be outlined in this document.
3
3
4
4
All of this has only been tested on Debian 10 & Fedora 28 (Linux).
5
5
@@ -12,7 +12,7 @@ All of this has only been tested on Debian 10 & Fedora 28 (Linux).
12
12
APT line: ` sudo apt install python3-pip && sudo pip3 install flit `
13
13
DNF line: ` sudo dnf install python3-flit `
14
14
15
- * Note* : Version ` 1.0 + ` of ` flit ` is required!
15
+ * Note* : Version ` 1.1 + ` of ` flit ` is required!
16
16
17
17
## Building the documentation
18
18
@@ -38,14 +38,17 @@ that will build it**:
38
38
Yes, we use IPFS to host our documentation. In case you haven't already you can download it here:
39
39
https://ipfs.io/docs/install/
40
40
41
- ### ` ipfs-file-publish `
41
+ ### A dedicated IPNS key for publishing
42
42
43
- This small utility copies files or directories into the IPFS [ MFS] ( https://ipfs.io/docs/commands/#ipfs-files )
44
- and then publishes the resulting hash as the node's primary hash. This is currently used to upload
45
- new versions of the documentation.
43
+ For publishing the documentation an IPNS key used only for this task should be
44
+ generated if there is no such key already:
46
45
47
- You can download it at:
48
- [ https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfs-file-publish ] ( https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfs-file-publish )
46
+ ` ipfs key gen --type ed25519 ipfs-http-client `
47
+
48
+ This key will need to be copied to all other system if the documentation is to
49
+ be published on these as well.
50
+
51
+ At the time of writing the officially used key is: * 12D3KooWEqnTdgqHnkkwarSrJjeMP2ZJiADWLYADaNvUb6SQNyPF*
49
52
50
53
51
54
# Steps when releasing a new version
@@ -62,10 +65,9 @@ You can download it at:
62
65
63
66
Run: ` flit build && flit upload `
64
67
65
- ## Re-generate the documentation
66
-
67
- Run: ` make -C docs/ html `
68
+ ## Re-generate and publish the documentation
68
69
69
- ## Publish the documentation
70
+ Run: ` docs/publish.py ipfs-http-client ` (were ` ipfs-http-client ` is the IPNS key ID)
70
71
71
- Make sure an IPFS daemon is running and run: ` ipfs-file-publish /Software/Python/ipfshttpclient/ docs/build/html/ `
72
+ The command will also print a commandline that may be used to mirror the generated
73
+ documentation on systems other then the current one.
0 commit comments