Revamped Nexus documentation for v1 (BlueBrain#123)

* Initial documentation structure

* Added minikube install instructions

* Corrected the minikube assets base

* Added wait for pods ready in between deployments

* Added missing kafka example, minor tweaks

* Running with Docker

* Replaced <mark> with bold

* Updated getting-started page names

* Added on premise instructions for dependent services

* Added the static schemas and contexts

* Added API docs on KG and ADMIN operations

* Updated material theme fixes bug

* Updated paradox version

* Add Web Apps standards page (BlueBrain#4)

* Updated build for automatic publishing to gh-pages

Additional fixes:
* removed duplicate software description from README.md
* minor formatting of markdown sources
* updated sbt to 1.2.4

.jvmopts

@@ -5,4 +5,4 @@
 -XX:+TieredCompilation
 -XX:+UseG1GC
 -XX:MaxMetaspaceSize=2G
--XX:-UseGCOverheadLimit
+-XX:-UseGCOverheadLimit

CONTRIBUTING.md

@@ -1,36 +1,46 @@
-# Contributing to the BlueBrain Nexus Platform
-We would love for you to contribute to the BlueBrain Nexus Platform and help make it even better than it is
-today! As a contributor, here are the guidelines we would like you to follow:
+# Contributing to the Blue Brain Nexus Platform
+
+We would love for you to contribute to the Blue Brain Nexus Platform and help make it even better than it is today! As a
+contributor, here are the guidelines we would like you to follow:
  - [Question or Problem?](#question)
  - [Issues and Bugs](#issue)
  - [Feature Requests](#feature)
  - [Submission Guidelines](#submit)
  - [Signing the CLA](#cla)
+
 ## <a name="question"></a> Got a Question or Problem?
-Please do not hesitate to contact the [BlueBrain Nexus team by email][nexus-team-email].
+
+Please do not hesitate to contact the [Blue Brain Nexus team by email][nexus-team-email].
+
 ## <a name="issue"></a> Found a Bug?
-If you find a bug in the source code, you can help us by
-[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can
-[submit a Pull Request](#submit-pr) with a fix.
+
+If you find a bug in the source code, you can help us by [submitting an issue](#submit-issue) to our
+[GitHub Repository][github]. Even better, you can [submit a Pull Request](#submit-pr) with a fix.
+
 ## <a name="feature"></a> Missing a Feature?
-You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub
-Repository. If you would like to *implement* a new feature, please submit an issue with
-a proposal for your work first, to be sure that we can use it.
+
+You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub Repository. If you would like to
+*implement* a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it.
+
 Please consider what kind of change it is:
 * For a **Major Feature**, first open an issue and outline your proposal so that it can be
 discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
 and help you to craft the change so that it is successfully accepted into the project.
 * **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
+
 ## <a name="submit"></a> Submission Guidelines
+
 ### <a name="submit-issue"></a> Submitting an Issue
-Before you submit an issue, please search the issue tracker, maybe an issue for your problem already
-exists and the discussion might inform you of workarounds readily available.
-We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and
-confirm it. In order to reproduce bugs we will need as much information as possible, and preferably
-be in touch with you to gather information. Please make sure that you include a contact email address
-in the issue content.
-You can file new issues by filling out our [new issue form][new-issue-form].
+
+Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the
+discussion might inform you of workarounds readily available.
+
+We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order
+to reproduce bugs we will need as much information as possible, and preferably be in touch with you to gather
+information.
+
 ### <a name="submit-pr"></a> Submitting a Pull Request (PR)
+
 Before you submit your Pull Request (PR) consider the following guidelines:
 * Please sign our [Contributor License Agreement (CLA)](#cla) before sending PRs.
   We cannot accept code without this.
@@ -59,9 +69,11 @@ Before you submit your Pull Request (PR) consider the following guidelines:
     git push -f
     ```
 That’s it! Thank you for your contribution!
+
 #### After your pull request is merged
-After your pull request is merged, you can safely delete your branch and pull the changes
-from the main (upstream) repository:
+
+After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream)
+repository:
 * Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
     ```shell
     git push origin --delete my-fix-branch
@@ -79,7 +91,10 @@ from the main (upstream) repository:
     git pull --ff upstream master
     ```
 ## <a name="cla"></a> Signing the CLA
-If you are not part of the BlueBrain project, a Contributor License Agreement (CLA) must be signed for any code changes to be accepted. Please contact the [BlueBrain Nexus team][nexus-team-email] to get the latest CLA version and instructions.
+
+If you are not part of the Blue Brain project, a Contributor License Agreement (CLA) must be signed for any code changes
+to be accepted. Please contact the [Blue Brain Nexus team][nexus-team-email] to get the latest CLA version and
+instructions.
 
 [nexus-team-email]: mailto:[email protected]
-[github]: https://github.com/bluebrain/nexus
+[github]: https://github.com/Blue Brain/nexus

Jenkinsfile

@@ -1,12 +1,14 @@
-def version = env.BRANCH_NAME
+String version = env.BRANCH_NAME
+Boolean isRelease = version ==~ /v\d+\.\d+\.\d+.*/
+Boolean isPR = env.CHANGE_ID != null
 
 pipeline {
     agent none
 
     stages {
         stage("Review") {
             when {
-                expression { env.CHANGE_ID != null }
+                expression { isPR }
             }
             steps {
                 node("slave-sbt") {
@@ -15,17 +17,14 @@ pipeline {
                 }
             }
         }
-        stage("Build Image") {
+        stage("Deploy GhPages") {
             when {
-                expression { env.CHANGE_ID == null && version ==~ /v\d+\.\d+\.\d+.*/ }
+                expression { !isPR && !isRelease }
             }
             steps {
                 node("slave-sbt") {
                     checkout scm
-                    sh "sbt clean paradox universal:packageZipTarball"
-                    sh "mv target/universal/docs.tgz ."
-                    sh "oc start-build docs-build --from-file=docs.tgz --follow"
-                    openshiftTag srcStream: 'docs', srcTag: 'latest', destStream: 'docs', destTag: version.substring(1), verbose: 'false'
+                    sh "sbt clean makeSite ghpagesPushSite"
                 }
             }
         }