add docs - steps for making a release

docs/index.rst

@@ -23,6 +23,7 @@ Elpis is a tool which language workers with minimal computational experience can
 
    wiki/viewing-elpis-training-log-file
    wiki/docker-build
+   wiki/make-elpis-release
    wiki/elpis-cli
    wiki/elpis-dev-recipe
 

docs/wiki/elpis-workshop.md

@@ -281,7 +281,9 @@ Again, we see progress through the transcription stages, and more speech recogni
 
 After the transcription is done, the transcription will show on the page, and the transcription can be downloaded in text or Elan format.
 
-![](assets/latest/140-transcribed.png)
+The transcription text may be shown in a range of tones from black to light grey. The darkness of the text is relative to how confident the system was about suggesting that text for that particular sound. This is knows as "confidence".  When you download the Elan file the confidence values are included on a tier. You can switch off the confidence display using the toggle switch on the right hand side of the panel. 
+
+![](assets/latest/145-transcribed-confidence.png)
 
 
 Listen in Elan.

docs/wiki/make-elpis-release.md

@@ -0,0 +1,85 @@
+# Making a release
+
+Follow these steps to make a release and new Docker image for Elpis. 
+
+
+## Update version in the code
+
+Update the changelog and version details in the Elpis repo.
+
+```
+~/sandbox/elpis/CHANGELOG.md
+~/sandbox/elpis/pyproject.toml
+~/sandbox/elpis/elpis/gui/package.json
+```
+
+## Docs
+
+Update docs if required with any description of changed functionality. Pushing to master will rebuild the readthedocs repo.
+
+
+## Try the code
+
+Test GUI build as a sanity check that the app builds and eslint is happy.
+
+```
+cd ~/sandbox/elpis/elpis/gui
+yarn install && yarn build
+```
+
+
+Build a new Docker image.
+
+```
+cd ~/sandbox/elpis
+docker build --tag elpis-latest-test .
+```
+
+
+Check that app runs with the new image. This isn't mounting any local repos in so it's a good way to check that the image is self-contained. 
+
+```
+docker run --rm -p 5000:5000/tcp elpis-latest-test
+```
+
+
+If it's all good, retag the image with the coedl org and push it to the Docker Hub
+
+```
+docker login
+docker tag elpis-latest-test coedl/elpis:latest
+docker tag elpis-latest-test coedl/elpis:0.96.10
+docker push coedl/elpis:latest 
+docker push coedl/elpis:0.96.10
+```
+
+
+You can push all tags with this command. But don't do this if you have random dev tags.
+
+```
+docker push coedl/elpis
+```
+
+
+Clean up Docker
+
+```
+docker image rm elpis-latest-test
+docker image prune -a
+```
+
+
+## Push Git version commit
+
+Push a commit for the version bump.
+
+
+## Make a Git release
+
+* Draft a [new release](https://github.com/CoEDL/elpis/releases/new)
+* Click `Choose a tag` and type the next version num including a leading `v`. E.g. `v0.96.10`
+* Leave release title empty to use the tag as the title.
+* Write a description of the release (should be the same as the changelog info).
+* Click `Publish release`. This will bundle the code as `.zip` and `.tar.gz` assets with the release.
+
+done