Merge branch 'master' into why-udaru

Conflicts:
	docs/_sidebar.md

README.md

@@ -71,7 +71,7 @@ As the Postgresql docker container has its 5432 port forwarded on the local mach
 To access the database using the pgAdmin you have to fill in also the container IP beside the database names and access credentials. The container IP can be seen with `docker ps`.  Use IP 127.0.0.1 and use postgres as username/password to connect to database server.
 
 ### Migrations
-We use [`postgrator`][postgrator] for database migrations. You can find the sql files in the [`database/migrations`](/database/migrations) folder. To run the migrations manually:
+We use [`postgrator`][postgrator] for database migrations. You can find the sql files in the [`database/migrations`](https://github.com/nearform/udaru/tree/master/database/migrations) folder. To run the migrations manually:
 
 ```
 node database/migrate.js --version=<version>`
@@ -247,7 +247,7 @@ Copyright nearForm Ltd 2017. Licensed under [MIT][license].
 [swagger-link]: http://localhost:8080/documentation
 [SQL Injection]: docs/sqlinjection.md
 [sqlmap]: https://github.com/sqlmapproject/sqlmap
-[sqlmap config]: ./security/fixtures/injection-endpoints.json
+[sqlmap config]: https://github.com/nearform/udaru/blob/master/security/fixtures/injection-endpoints.json
 [docs-site]: https://nearform.github.io/udaru
 [swagger-docs-url]: https://nearform.github.io/udaru/swagger/
 

docs/index.html

@@ -21,6 +21,7 @@
     homepage: 'https://raw.githubusercontent.com/nearform/udaru/master/docs/overview.md',
     alias: {
       '\/docs\/(.*)': '/$1', // supports regexp
+      '/./LICENSE': 'https://raw.githubusercontent.com/nearform/udaru/master/LICENSE.md'
     }
   }
 </script>

lib/plugin/config/swagger.js

@@ -0,0 +1,42 @@
+const packageJson = require('../../../package.json')
+
+module.exports = {
+  jsonEditor: true,
+  reuseDefinitions: false,
+  grouping: 'tags',
+  info: {
+    title: 'Udaru API Documentation',
+    description: 'This page documents Udaru\'s API endpoints, along with their various inputs and outputs. For more information about Udaru please see the <a href="https://nearform.github.io/udaru">Documentation Site.</a>',
+    version: packageJson.version
+  },
+  tags: [
+    {
+      name: 'policies',
+      description: 'Manage policy objects'
+    },
+    {
+      name: 'organizations',
+      description: 'Manage organizations'
+    },
+    {
+      name: 'teams',
+      description: 'Manage teams within an organization'
+    },
+    {
+      name: 'users',
+      description: 'Manage users within an organization'
+    },
+    {
+      name: 'authorization',
+      description: 'Manage the actions a user can perform against a resource'
+    },
+    {
+      name: 'private',
+      description: 'Endpoints that require a service key'
+    },
+    {
+      name: 'monitoring',
+      description: 'Endpoints for monitoring and uptime'
+    }
+  ]
+}

lib/server/index.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const packageJson = require('../../package.json')
 const config = require('../plugin/config')
 
 const Hapi = require('hapi')
@@ -14,46 +13,6 @@ server.connection({
   }
 })
 
-const swaggerOptions = {
-  jsonEditor: true,
-  reuseDefinitions: false,
-  grouping: 'tags',
-  info: {
-    title: 'Authorization API Documentation',
-    version: packageJson.version
-  },
-  tags: [
-    {
-      name: 'policies',
-      description: 'Manage policy objects'
-    },
-    {
-      name: 'organizations',
-      description: 'Manage organizations'
-    },
-    {
-      name: 'teams',
-      description: 'Manage teams within an organization'
-    },
-    {
-      name: 'users',
-      description: 'Manage users within an organization'
-    },
-    {
-      name: 'authorization',
-      description: 'Manage the actions a user can perform against a resource'
-    },
-    {
-      name: 'private',
-      description: 'Endpoints that require a service key'
-    },
-    {
-      name: 'monitoring',
-      description: 'Endpoints for monitoring and uptime'
-    }
-  ]
-}
-
 server.register(
   [
     {
@@ -68,7 +27,7 @@ server.register(
     },
     {
       register: require('hapi-swagger'),
-      options: swaggerOptions
+      options: require('../plugin/config/swagger')
     },
     {
       register: require('../plugin')

package.json

@@ -85,9 +85,9 @@
     "pg-copy-streams": "^1.2.0",
     "pre-commit": "^1.2.2",
     "proxyquire": "^1.7.10",
-    "remark-cli": "^3.0.0",
+    "remark-cli": "^4.0.0",
     "remark-lint": "^6.0.0",
-    "remark-preset-lint-recommended": "^2.0.0",
+    "remark-preset-lint-recommended": "^3.0.0",
     "standard": "^8.6.0",
     "swagger-gen": "^1.1.3"
   },