From eb7d34c92dcf5743c2e2cee2e6614e958126abc0 Mon Sep 17 00:00:00 2001 From: Tanner Collin Date: Thu, 7 Apr 2022 19:58:20 +0000 Subject: [PATCH] Improve docs --- apiserver/docs/source/api.md | 2 +- apiserver/docs/source/dev_apiserver.md | 2 +- apiserver/docs/source/dev_running.md | 3 ++- apiserver/docs/source/dev_webclient.md | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/apiserver/docs/source/api.md b/apiserver/docs/source/api.md index 498ff7a..48f0e17 100644 --- a/apiserver/docs/source/api.md +++ b/apiserver/docs/source/api.md @@ -1,6 +1,6 @@ # Spaceport API -The current API URL is: https://api.my.protospace.ca/ +The current API URL is: [https://api.my.protospace.ca/](https://api.my.protospace.ca/). JSON is returned by all API responses including errors and HTTP response status codes are to designate success and failure. diff --git a/apiserver/docs/source/dev_apiserver.md b/apiserver/docs/source/dev_apiserver.md index 1308ea2..8109ad4 100644 --- a/apiserver/docs/source/dev_apiserver.md +++ b/apiserver/docs/source/dev_apiserver.md @@ -1,6 +1,6 @@ # API Server Development Setup -This guide assumes you are using Debian GNU/Linux 11 or Ubuntu 20.04 LTS. If you +This guide assumes you are using [Debian GNU/Linux 11](https://cdimage.debian.org/cdimage/unofficial/non-free/images-including-firmware/archive/11.2.0+nonfree/amd64/iso-cd/firmware-11.2.0-amd64-netinst.iso) or [Ubuntu 20.04 LTS](https://releases.ubuntu.com/20.04/). If you aren't, just spin up a VM with the correct version. Things break if you don't. ## Install Dependencies diff --git a/apiserver/docs/source/dev_running.md b/apiserver/docs/source/dev_running.md index 86f02d7..ffa37a4 100644 --- a/apiserver/docs/source/dev_running.md +++ b/apiserver/docs/source/dev_running.md @@ -12,7 +12,8 @@ IP if your virtual machine or server is. Open the web client [http://127.0.0.1:3000/](http://127.0.0.1:3000/) in your browser. Fill out the "Sign Up to Spaceport" form. If you see a "Please Visit Protospace" -warning, this means the web client can't talk to the API server properly. +warning, this means the web client can't talk to the API server properly. Hit +Sign Up and finish the registration. Navigate to [http://127.0.0.1:8000/admin/api/member/1/change/](http://127.0.0.1:8000/admin/api/member/1/change/) and log in with the super user credentials you created during the API server setup. diff --git a/apiserver/docs/source/dev_webclient.md b/apiserver/docs/source/dev_webclient.md index 822149f..2debaac 100644 --- a/apiserver/docs/source/dev_webclient.md +++ b/apiserver/docs/source/dev_webclient.md @@ -1,6 +1,6 @@ # Web Client Development Setup -This guide assumes you are using Debian GNU/Linux 11 or Ubuntu 20.04 LTS. If you +This guide assumes you are using [Debian GNU/Linux 11](https://cdimage.debian.org/cdimage/unofficial/non-free/images-including-firmware/archive/11.2.0+nonfree/amd64/iso-cd/firmware-11.2.0-amd64-netinst.iso) or [Ubuntu 20.04 LTS](https://releases.ubuntu.com/20.04/). If you aren't, just spin up a VM with the correct version. Things break if you don't. ## Install Dependencies