Skip to content

Commit

Permalink
docs: Consolidating header hierarchy slightly
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
cdecker authored and rustyrussell committed Feb 18, 2019
1 parent ac6d9b3 commit 8867004
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 10 deletions.
3 changes: 3 additions & 0 deletions doc/HACKING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Hacking
=======

Welcome, fellow coder!

This repository contains a code to run a lightning protocol daemon.
Expand Down
4 changes: 3 additions & 1 deletion doc/INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Table of Contents
Install
=======

1. [Library Requirements](#library-requirements)
2. [Ubuntu](#to-build-on-ubuntu)
3. [Fedora](#to-build-on-fedora)
Expand Down
14 changes: 8 additions & 6 deletions doc/MAKING-RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Release checklist

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
this release which may cause delay.
Expand All @@ -9,22 +11,22 @@ Here's a checklist for the release process.
3. Ask the most significant contributor who has not already named a
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.
2. Update the CHANGELOG.md with [Unreleased] changed to -rc1, and add a new
footnote.
3. Create a PR with the above.

## Releasing -rc1
### Releasing -rc1

1. Merge the PR above.
2. Tag it `git pull && git tag -s v<VERSION>rc1 && git push --tags`
3. Update the /topic on #c-lightning on Freenode.
4. Prepare draft release notes, and share with team for editing.
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
[Unreleased] footnote URL from the previous version to the
Expand All @@ -41,15 +43,15 @@ Here's a checklist for the release process.
with `gpg --verify SHA256SUMS.asc` and include the file in the draft
release.

## Performing the Release
### Performing the Release

1. Edit the GitHub draft and include the `SHA256SUMS.asc` file.
2. Publish the release as not a draft.
3. Update the /topic on #c-lightning on Freenode.
4. Send a mail to c-lightning and lightning-dev mailing lists, using the
same wording as the Release Notes in github.

## Post-release
### Post-release

1. Add a new '[Unreleased]' section the CHANGELOG.md with empty headers.
2. Look through PRs which were delayed for release and merge them.
5 changes: 2 additions & 3 deletions doc/TOR.md
Original file line number Diff line number Diff line change
@@ -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.

i.e.
```
```bash
sudo apt install tor
```
then `/etc/init.d/tor start` or `sudo systemctl start tor` Depending
Expand Down

0 comments on commit 8867004

Please sign in to comment.