Documentation Fixes [work in progress] #37
Conversation
| - [Spark Streaming connector for RSS](https://github.com/CatalystCode/streaming-rss-html) | ||
| - [Advanced filtering options for Twitter Spark Streaming connector](https://github.com/apache/bahir/pull/43) | ||
|
|
||
| ## Known Docker Issues |
There was a problem hiding this comment.
This low-level development information should probably go to development-faq.md (as a matter of fact, the Docker one is already there)
|
|
||
| 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. | ||
|
|
||
| A full list of products and services can be found [here](https://azure.microsoft.com/en-us/services/). |
There was a problem hiding this comment.
Please add a listing of the Azure resources that Fortis specifically uses for context. You can refer to the architecture diagram at https://user-images.githubusercontent.com/1086421/36809325-9b4f0542-1c95-11e8-9817-6af1939e4a1b.png to compile this list.
| 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) | ||
| directory which you can use as a template. | ||
|
|
||
| ## Common Errors |
There was a problem hiding this comment.
Nit: the rest of the headings in this section are phrased like questions given that this is supposed to be a FAQ.
Also: "common errors" is not a very specific heading given that this entire document is common errors. This section could be called more specifically: "How do I get the UI to load?" or similar.
| @@ -0,0 +1,154 @@ | |||
| # Commonly Used Libraries | |||
There was a problem hiding this comment.
This only lists the Node libraries, but we also have Bash libraries, Scala libraries, etc.
|
|
||
| If you're facing any issues, refer to the [Development FAQ](./development-faq.md). | ||
|
|
||
|
|
|
|
||
| And you can create an account for free [here](https://azure.microsoft.com/en-us/free/). | ||
|
|
||
| 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/) and [Active Directory v2](https://azure.microsoft.com/en-us/services/active-directory/). |
There was a problem hiding this comment.
| @@ -0,0 +1,154 @@ | |||
| # Commonly Used Libraries | |||
|
|
|||
| Here is a list of the dependencies we're using on the project, with a brief explanation of their purpose and link to documentation for ease of use. | |||
There was a problem hiding this comment.
This list is very extensive and some of the libraries are very minorly used... you're the expert in this area, but is it really worthwhile to document every little dependency that we have? Isn't this information that someone can just look up from the npm page if they're interested?
Why not instead explain the top level concerns instead of the low level details? E.g. what each of the sub-folders does and the main technologies that it uses?
Opening this PR as I make changes outlined here: CatalystCode/project-fortis-pipeline#253 to the documentation.