From 886700454dec18fbed8e9215136ec2c30ad1e462 Mon Sep 17 00:00:00 2001 From: Christian Decker Date: Fri, 8 Feb 2019 16:06:34 +0100 Subject: [PATCH] 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 --- doc/HACKING.md | 3 +++ doc/INSTALL.md | 4 +++- doc/MAKING-RELEASES.md | 14 ++++++++------ doc/TOR.md | 5 ++--- 4 files changed, 16 insertions(+), 10 deletions(-) diff --git a/doc/HACKING.md b/doc/HACKING.md index cf015c959..8a4efdeaa 100644 --- a/doc/HACKING.md +++ b/doc/HACKING.md @@ -1,3 +1,6 @@ +Hacking +======= + Welcome, fellow coder! This repository contains a code to run a lightning protocol daemon. diff --git a/doc/INSTALL.md b/doc/INSTALL.md index f2162e9f5..00f6a7865 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -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) diff --git a/doc/MAKING-RELEASES.md b/doc/MAKING-RELEASES.md index 24f5d9930..9ef973283 100644 --- a/doc/MAKING-RELEASES.md +++ b/doc/MAKING-RELEASES.md @@ -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. @@ -9,14 +11,14 @@ 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 vrc1 && 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. 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 @@ -41,7 +43,7 @@ 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. @@ -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 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. diff --git a/doc/TOR.md b/doc/TOR.md index 1d4e7f856..4dc4a5bf3 100644 --- a/doc/TOR.md +++ b/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. -i.e. -``` +```bash sudo apt install tor ``` then `/etc/init.d/tor start` or `sudo systemctl start tor` Depending