docs: review changes

Minor edits and additions as a result of review. Signed-off-by: Richard Case <richard@weave.works>
weaveworks-liquidmetal · Nov 3, 2021 · e60369e · e60369e
1 parent 4a0d255
commit e60369e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,9 @@ See our [getting started with flintlock][quickstart] guide.
 
 ## Contributing
 
-Contributions are welcome. Please read the [CONTRIBUTING.md][contrib] and our [Code Of Conduct][coc]. We have the [#liquid-metal](https://weave-community.slack.com/archives/C02KARWGR7S) slack channel for discussions when contributors and users.
+Contributions are welcome. Please read the [CONTRIBUTING.md][contrib] and our [Code Of Conduct][coc]. 
+
+You can reach out to the maintainers and other contributors using the [#liquid-metal](https://weave-community.slack.com/archives/C02KARWGR7S) slack channel.
 
 Other interesting resources include:
 

diff --git a/docs/releasing.md b/docs/releasing.md
@@ -6,20 +6,28 @@
 
 The projects follows [semantic versioning](https://semver.org/#semantic-versioning-200) and so the release version must adhere to this specification. Depending on the changes in the release you will need to decide the next appropriate version number.
 
+Its advised that you pull the tags and view the latest release (i.e. tag):
+
+```bash
+git pull --tags
+
+git describe --tags --abbrev=0
+```
+
 ## Create tag
 
 * Checkout upstream main
 * Create a tag with the version number:
 
 ```bash
 RELEASE_VERSION=v0.1.0-alpha.1
-git tag -s ${RELEASE_VERSION} -m "${RELEASE_VERSION}
+git tag -s "${RELEASE_VERSION}" -m "${RELEASE_VERSION}"
 ```
 
 * Push the tag (to upstream if working from a fork)
 
 ``` bash
-git push origin ${RELEASE_VERSION}
+git push origin "${RELEASE_VERSION}"
 ```
 
 * Check the [release](https://github.com/weaveworks/flintlock/actions/workflows/release.yml) GitHub Actions workflow completes successfully.