Browse Source

docs: Consolidating header hierarchy slightly

This is a preparatory step for the automatic documentation generation
that is going to use `sphinx-doc`. Each document should include a top
level header that matches the name and scope of the document and all
following headers should be of a lower level than the top-level
header.

Signed-off-by: Christian Decker <decker.christian@gmail.com>
connected_hook
Christian Decker 6 years ago
committed by Rusty Russell
parent
commit
886700454d
  1. 3
      doc/HACKING.md
  2. 4
      doc/INSTALL.md
  3. 14
      doc/MAKING-RELEASES.md
  4. 5
      doc/TOR.md

3
doc/HACKING.md

@ -1,3 +1,6 @@
Hacking
=======
Welcome, fellow coder! Welcome, fellow coder!
This repository contains a code to run a lightning protocol daemon. This repository contains a code to run a lightning protocol daemon.

4
doc/INSTALL.md

@ -1,4 +1,6 @@
# Table of Contents Install
=======
1. [Library Requirements](#library-requirements) 1. [Library Requirements](#library-requirements)
2. [Ubuntu](#to-build-on-ubuntu) 2. [Ubuntu](#to-build-on-ubuntu)
3. [Fedora](#to-build-on-fedora) 3. [Fedora](#to-build-on-fedora)

14
doc/MAKING-RELEASES.md

@ -1,6 +1,8 @@
## Release checklist
Here's a checklist for the release process. Here's a checklist for the release process.
## Leading Up To The Release ### Leading Up To The Release
1. Talk to team about whether there are any changes which MUST go in 1. Talk to team about whether there are any changes which MUST go in
this release which may cause delay. this release which may cause delay.
@ -9,14 +11,14 @@ Here's a checklist for the release process.
3. Ask the most significant contributor who has not already named a 3. Ask the most significant contributor who has not already named a
release to name the release. CC previous namers and team. release to name the release. CC previous namers and team.
## Prepering for -rc1 ### Prepering for -rc1
1. Check that CHANGELOG.md covers all signficant changes. 1. Check that CHANGELOG.md covers all signficant changes.
2. Update the CHANGELOG.md with [Unreleased] changed to -rc1, and add a new 2. Update the CHANGELOG.md with [Unreleased] changed to -rc1, and add a new
footnote. footnote.
3. Create a PR with the above. 3. Create a PR with the above.
## Releasing -rc1 ### Releasing -rc1
1. Merge the PR above. 1. Merge the PR above.
2. Tag it `git pull && git tag -s v<VERSION>rc1 && git push --tags` 2. Tag it `git pull && git tag -s v<VERSION>rc1 && git push --tags`
@ -24,7 +26,7 @@ Here's a checklist for the release process.
4. Prepare draft release notes, and share with team for editing. 4. Prepare draft release notes, and share with team for editing.
5. Upgrade your personal nodes to the rc1, to help testing. 5. Upgrade your personal nodes to the rc1, to help testing.
## Tagging the Release ### Tagging the Release
1. Update the CHANGELOG.md; remove -rc1 in both places, and move the 1. Update the CHANGELOG.md; remove -rc1 in both places, and move the
[Unreleased] footnote URL from the previous version to the [Unreleased] footnote URL from the previous version to the
@ -41,7 +43,7 @@ Here's a checklist for the release process.
with `gpg --verify SHA256SUMS.asc` and include the file in the draft with `gpg --verify SHA256SUMS.asc` and include the file in the draft
release. release.
## Performing the Release ### Performing the Release
1. Edit the GitHub draft and include the `SHA256SUMS.asc` file. 1. Edit the GitHub draft and include the `SHA256SUMS.asc` file.
2. Publish the release as not a draft. 2. Publish the release as not a draft.
@ -49,7 +51,7 @@ Here's a checklist for the release process.
4. Send a mail to c-lightning and lightning-dev mailing lists, using the 4. Send a mail to c-lightning and lightning-dev mailing lists, using the
same wording as the Release Notes in github. same wording as the Release Notes in github.
## Post-release ### Post-release
1. Add a new '[Unreleased]' section the CHANGELOG.md with empty headers. 1. Add a new '[Unreleased]' section the CHANGELOG.md with empty headers.
2. Look through PRs which were delayed for release and merge them. 2. Look through PRs which were delayed for release and merge them.

5
doc/TOR.md

@ -1,9 +1,8 @@
# HOWTO USE TOR WITH C-LIGHTNING # Setting up TOR with c-lightning
to use tor you have to have tor installed an running. to use tor you have to have tor installed an running.
i.e. ```bash
```
sudo apt install tor sudo apt install tor
``` ```
then `/etc/init.d/tor start` or `sudo systemctl start tor` Depending then `/etc/init.d/tor start` or `sudo systemctl start tor` Depending

Loading…
Cancel
Save