Skip to content

Commit 4c519cb

Browse files
committed
[docs] Update releasing documentation
1 parent d61cfb9 commit 4c519cb

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

docs/releasing.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
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.
33

44
All of this has only been tested on Debian 10 & Fedora 28 (Linux).
55

@@ -12,7 +12,7 @@ All of this has only been tested on Debian 10 & Fedora 28 (Linux).
1212
APT line: `sudo apt install python3-pip && sudo pip3 install flit`
1313
DNF line: `sudo dnf install python3-flit`
1414

15-
*Note*: Version `1.0+` of `flit` is required!
15+
*Note*: Version `1.1+` of `flit` is required!
1616

1717
## Building the documentation
1818

@@ -38,14 +38,17 @@ that will build it**:
3838
Yes, we use IPFS to host our documentation. In case you haven't already you can download it here:
3939
https://ipfs.io/docs/install/
4040

41-
### `ipfs-file-publish`
41+
### A dedicated IPNS key for publishing
4242

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:
4645

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*
4952

5053

5154
# Steps when releasing a new version
@@ -62,10 +65,9 @@ You can download it at:
6265

6366
Run: `flit build && flit upload`
6467

65-
## Re-generate the documentation
66-
67-
Run: `make -C docs/ html`
68+
## Re-generate and publish the documentation
6869

69-
## Publish the documentation
70+
Run: `docs/publish.py ipfs-http-client` (were `ipfs-http-client` is the IPNS key ID)
7071

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

Comments
 (0)