From 03fed938bf49fa6791ec3830e622cf4534ef991b Mon Sep 17 00:00:00 2001 From: Miguel Mota Date: Tue, 23 Feb 2021 01:19:11 -0800 Subject: [PATCH] Update contributing docs --- docs/content/contributing.md | 12 ++++++++++++ docs/content/faq.md | 8 ++++++++ 2 files changed, 20 insertions(+) diff --git a/docs/content/contributing.md b/docs/content/contributing.md index 4fdca68..9f98242 100644 --- a/docs/content/contributing.md +++ b/docs/content/contributing.md @@ -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/) diff --git a/docs/content/faq.md b/docs/content/faq.md index bc7238e..d706e6e 100644 --- a/docs/content/faq.md +++ b/docs/content/faq.md @@ -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: