Update contributing docs

pull/94/head
Miguel Mota 3 years ago
parent 3aed9846fe
commit 03fed938bf

@ -10,3 +10,15 @@ Pull requests are welcome!
For contributions please create a new branch and submit a pull request for review.
Huge thanks to all the [contributors](https://github.com/miguelmota/cointop/graphs/contributors) that have made cointop better.
## Documentation
Keeping documentation up-to-date is always appreciated! If you'd like to make edits or make additions to the docs, the respective files are located under [`docs/content`](https://github.com/miguelmota/cointop/tree/master/docs/content)
Run the documentation locally with:
```bash
make docs-server
```
Visit [http://localhost:8080/](http://localhost:8080/)

@ -392,6 +392,14 @@ draft: false
sudo cointop server -p 22
```
## Does using the public SSH instance track me?
No, there's no tracking on the public SSH server instance. It's running the same code that you see on the public repo.
## Why does the public SSH server kick me off?
The public SSH instance is for demo use or short-term usage and will disconnect users after an idle timeout to allow other users to try it out.
## Why doesn't the version number work when I install with `go get`?
The version number is read from the git tag during the build process but this requires the `GO111MODULE` environment variable to be set in order for Go to read the build information:

Loading…
Cancel
Save