ci: add Jenkinsfile, requirements.txt and redirect

This adds CI builds for both main branches:

* `develop` built by [CI job](https://ci.status.im/job/website/job/dev-help.status.im/) to publish to https://dev-help.status.im/
* `master` built by [CI job](https://ci.status.im/job/website/job/help.status.im/) to publish to https://help.status.im/

Changes should be made against `develop` and then once ready `master`
should be rebased on `develop` to push the changes to the main site.

Related: status-im/infra-misc@305f9445
Resolves: #27

Signed-off-by: Jakub Sokołowski <[email protected]>

Author: jakubgs

.github/workflows/ghpci.yml

@@ -1,2 +1,3 @@
 .DS_Store
+.venv
 generated

.gitignore

@@ -0,0 +1,62 @@
+pipeline {
+  agent {
+    label 'linux'
+  }
+
+  options {
+    disableConcurrentBuilds()
+    /* manage how many builds we keep */
+    buildDiscarder(logRotator(
+      numToKeepStr: '20',
+      daysToKeepStr: '30',
+    ))
+  }
+
+  environment {
+    GIT_COMMITTER_NAME = 'status-im-auto'
+    GIT_COMMITTER_EMAIL = '[email protected]'
+    /* dev page settings */
+    DEV_SITE = 'dev-help.status.im'
+    DEV_HOST = '[email protected]'
+    SCP_OPTS = 'StrictHostKeyChecking=no'
+  }
+
+  stages {
+    stage('Deps') {
+      steps {
+        sh "pip install --user -r requirements.txt"
+      }
+    }
+
+    stage('Build') {
+      steps {
+        sh "python -m mkdocs build -f config/en/mkdocs.yml"
+        sh "python -m mkdocs build -f config/style-guide/mkdocs.yml"
+        /* Temporary solution for lack of start page. */
+        sh "cp overrides/static/* generated/"
+        echo "${GIT_BRANCH}"
+      }
+    }
+
+    stage('Publish Prod') {
+      when { expression { env.GIT_BRANCH ==~ /.*master/ } }
+      steps {
+        sshagent(credentials: ['status-im-auto-ssh']) {
+          sh "ghp-import -p generated"
+        }
+      }
+    }
+
+    stage('Publish Devel') {
+      when { expression { !(env.GIT_BRANCH ==~ /.*master/) } }
+      steps {
+        sshagent(credentials: ['jenkins-ssh']) {
+          sh """
+            rsync -e 'ssh -o ${SCP_OPTS}' -r --delete generated/. \
+              ${env.DEV_HOST}:/var/www/${env.DEV_SITE}/
+          """
+        }
+      }
+    }
+  }
+}

Jenkinsfile

@@ -30,6 +30,15 @@ For more complex contributions, you can [open an issue](https://github.com/statu
 
 If you're looking for a way to contribute, you can scan through [our existing issues](https://github.com/status-im/help.status.im/issues) for something to work on. When ready, check our [contributing guide](https://github.com/status-im/help.status.im/blob/master/CONTRIBUTING.md) for detailed instructions.
 
+## Continuous Integration
+
+Two branches are built by [our Jenkins instance](https://ci.status.im/):
+
+* `master` is deployed to https://help.status.im/ by [CI](https://ci.status.im/job/website/job/help.status.im/)
+* `develop` is deployed to https://dev-help.status.im/ by [CI](https://ci.status.im/job/website/job/dev-help.status.im/)
+
+PRs should be made for `develop` branch and `master` should be [rebased](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) on `develop` once changes are verified.
+
 ## License
 
 The Status user documentation is licensed under the MIT license. The Material for MkDocs components of our documentation are licensed under the [Material for MkDocs license](https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE).

README.md

@@ -13,7 +13,7 @@ site_dir: '../../generated/en/'
 # Repository
 repo_name: 'Status Help'
 repo_url: https://github.com/status-im/help.status.im
-edit_uri: edit/master/docs/en
+edit_uri: edit/develop/docs/en
 
 # Copyright
 copyright: 'Status Research & Development GmbH'
@@ -83,7 +83,6 @@ markdown_extensions:
   - pymdownx.tabbed:
       alternate_style: true
   - abbr
-  - pymdownx.snippets
   - pymdownx.emoji:
       emoji_index: !!python/name:materialx.emoji.twemoji
       emoji_generator: !!python/name:materialx.emoji.to_svg

config/en/mkdocs.yml

@@ -13,7 +13,7 @@ site_dir: '../../generated/style-guide/'
 # Repository
 repo_name: 'Status Help'
 repo_url: https://github.com/status-im/help.status.im
-edit_uri: edit/master/docs/style-guide
+edit_uri: edit/develop/docs/style-guide
 
 # Copyright
 copyright: 'Status Research & Development GmbH'
@@ -140,4 +140,4 @@ nav:
   - Welcome: index.md
   - Style guidelines: style-guidelines.md
   - Structuring the content: structuring-the-content.md
-  - Style conventions: style-conventions.md
+  - Style conventions: style-conventions.md

config/style-guide/mkdocs.yml

@@ -1,6 +1,6 @@
-[download-status-for-linux]: /help.status.im/getting-started/download-status-for-linux
-[download-status-for-mac]: /help.status.im/getting-started/download-status-for-mac
-[run-status-app-first-time]: /help.status.im/getting-started/run-status-app-first-time
+[download-status-for-linux]: /en/getting-started/download-status-for-linux
+[download-status-for-mac]: /en/getting-started/download-status-for-mac
+[run-status-app-first-time]: /en/getting-started/run-status-app-first-time
 
 [gnu-privacy-guard]: https://gnupg.org/
-[status-web-download]: https://status.im/get
+[status-web-download]: https://status.im/get

includes/urls-en.txt

@@ -0,0 +1 @@
+help.status.im

overrides/static/CNAME

@@ -0,0 +1,11 @@
+<!doctype html>
+<html>
+    <head>
+        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+        <meta http-equiv="refresh" content="0; url=/en/" />
+        <title>Status Help Redirect</title>
+    </head>
+    <body>
+        If you are not redirected automatically, follow <a href="/en/">this link</a>.
+    </body>
+</html>

overrides/static/index.html

@@ -0,0 +1 @@
+User-agent: *