Skip to content

Commit 082e022

Browse files
rachelnicolec-w
authored andcommitted
Documentation Fixes (#37)
Resolves CatalystCode/project-fortis-pipeline#253
1 parent 717f7ee commit 082e022

File tree

3 files changed

+19
-4
lines changed

3 files changed

+19
-4
lines changed

project-fortis-pipeline/docs/development-faq.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,3 +137,7 @@ that pre-populate your Fortis site.
137137

138138
There are several examples of tar.gz files to bootstrap sites in the [seed-data](https://github.com/CatalystCode/project-fortis/tree/master/project-fortis-pipeline/localdeploy/seed-data)
139139
directory which you can use as a template.
140+
141+
## Why isn't my UI loading?
142+
143+
If you see `An error occurred while loading the page: GraphQL call failed` when trying to load the Dashboard, your `docker-compose up` process is either not done running, or you might need to pull down fresh from your Master branch and rebuild.

project-fortis-pipeline/docs/development-setup.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ single resource group whose name is stored under the
4343

4444
### Generating Mapbox access token
4545

46+
Mapbox is a service that allows you to simply create beautiful maps and location services through APIs and SDKs. They have extensive documentation which you can find [here](https://www.mapbox.com/api-documentation/#maps).
47+
4648
Next, you need to create a Mapbox access token. If you don't have one yet, you
4749
can create a new one for free by [signing up](https://www.mapbox.com/signup/).
4850
Once you have the token, append it to the `.env-secrets` file like so:
@@ -121,4 +123,4 @@ Note that any changes to the React code in project-fortis-interfaces folder will
121123
be automatically detected and re-loaded so the re-build step above won't be
122124
necessary for changes to the frontend.
123125

124-
If you're facing any issues, refer to the [Development FAQ](./development-faq.md).
126+
If you're facing any issues, refer to the [Development FAQ](./development-faq.md).

project-fortis-pipeline/docs/production-setup.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
1-
# Fortis production setup
1+
# Fortis production
22

33
## Prerequisites
44

55
### Azure subscription
66

7-
First and foremost, you'll need an Azure subscription. You can create one for
8-
free [here](https://azure.microsoft.com/en-us/free/).
7+
First and foremost, you'll need an Azure subscription.
8+
9+
Azure is a comprehensive set of cloud services that developers and IT professionals use to build, deploy, and manage applications through our global network of datacenters. Integrated tools, DevOps, and a marketplace support you in efficiently building anything from simple mobile apps to internet-scale solutions.
10+
11+
A full list of products and services can be found [here](https://azure.microsoft.com/en-us/services/).
12+
13+
And you can create an account for free [here](https://azure.microsoft.com/en-us/free/).
14+
15+
For this project we're using these services: [Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/), [Cognitive Services](https://azure.microsoft.com/en-us/services/cognitive-services/), [Azure Database for PostgreSQL](https://azure.microsoft.com/en-us/services/postgresql/), [Service Bus](https://azure.microsoft.com/en-us/services/service-bus/), [Active Directory v2](https://azure.microsoft.com/en-us/services/active-directory/), [Container Service](https://azure.microsoft.com/en-us/services/container-service/) and [Event Hubs](https://azure.microsoft.com/en-us/services/event-hubs/).
916

1017
### Secure your Fortis site with TLS
1118

19+
TLS is the successcor to SSL. The TLS protocol aims primarily to provide privacy and data integrity between two communicating computer applications. You can find more information about it [here](https://en.wikipedia.org/wiki/Transport_Layer_Security)
20+
1221
To enable TLS and secure your Fortis site, you have two choices:
1322

1423
1. Provide your own TLS certificate and private key

0 commit comments

Comments
 (0)