BREAKING CHANGE: implement docusaurus

.gitignore

@@ -1,61 +1,26 @@
-.DS_Store
-.idea/
-node_modules/
-*.log
-db.json
-.deploy*/
-package-lock.json
-public/
-
-# Composer
-/vendor
-composer.phar
-
-# IntelliJ - PhpStorm and PyCharm
-*.ipr
-*.iws
-
-# Eclipse
-/.project
-/.settings
-/.classpath
-
-# Logs
-logs
-error.log
-access.log
+# Dependencies
+/node_modules
 
-# Netbeans
-nbproject
-.nbproject
-.nbproject/*
-nbproject/*
-nbproject/private/
-/nbbuild/
-/nbdist/
-nbactions.xml
-nb-configuration.xml
+# Production
+/build
 
-# Thumbnails
-._*
-# Files that might appear on external disk
-.Spotlight-V100
-.Trashes
-
-# SublimeText project files
-/*.sublime-project
-*.sublime-workspace
-
-# Dart
-packages
-packages/*
-
-# Vagrant
-.vagrant
-.vagrant/*
+# Generated files
+.docusaurus
+.cache-loader
 
+# Misc
+.DS_Store
 .env
-
-# built assets
-themes/navy/source/js/vendor.js
-themes/navy/source/js/vendor.js.map
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.yalc
+yalc.lock
+.idea
+
+static/search-index.json

.husky/commit-msg

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# yarn prettier:staged
+yarn typecheck

.prettierignore

@@ -0,0 +1,2 @@
+*.mdx
+*.md

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all"
+}

Jenkinsfile

@@ -11,55 +11,51 @@ pipeline {
   }
 
   environment {
-    GIT_USER = 'status-im-auto'
-    GIT_MAIL = '[email protected]'
-    /* Dev site deployment. */
-    DEV_SITE = 'dev.nimbus.team'
-    DEV_HOST = '[email protected]'
-    SCP_OPTS = 'StrictHostKeyChecking=no'
+    GIT_COMMITTER_NAME = 'status-im-auto'
+    GIT_COMMITTER_EMAIL = '[email protected]'
+    PROD_SITE = 'nimbus.team'
+    DEV_SITE  = 'dev.nimbus.team'
+    DEV_HOST  = '[email protected]'
+    SCP_OPTS  = 'StrictHostKeyChecking=no'
   }
 
   stages {
-
-    stage('Install Deps') {
+    stage('Install') {
       steps {
-        sh 'yarn install'
+        sh "yarn install"
       }
     }
 
     stage('Build') {
       steps {
-        sh 'yarn run clean'
-        sh 'yarn run build'
+        sh 'yarn build'
+        sh "echo ${env.PROD_SITE} > build/CNAME"
       }
     }
 
-    stage('Robot') {
-      when { expression { !GIT_BRANCH.endsWith('master') } }
-      steps { script {
-        sh 'echo "Disallow: /" >> public/robots.txt'
-      } }
-    }
-
     stage('Publish Prod') {
-      when { expression { GIT_BRANCH.endsWith('master') } }
-      steps { script {
+      when { expression { env.GIT_BRANCH ==~ /.*master/ } }
+      steps {
         sshagent(credentials: ['status-im-auto-ssh']) {
-          sh 'yarn run deploy'
+          sh "ghp-import -p build"
         }
-      } }
+      }
     }
 
     stage('Publish Devel') {
-      when { expression { !GIT_BRANCH.endsWith('master') } }
-      steps { script {
+      when { expression { env.GIT_BRANCH !=~ /.*master/ } }
+      steps {
         sshagent(credentials: ['jenkins-ssh']) {
           sh """
-            rsync -e 'ssh -o ${SCP_OPTS}' -r --delete public/. \
-            ${env.DEV_HOST}:/var/www/${env.DEV_SITE}/
+            rsync -e 'ssh -o ${SCP_OPTS}' -r --delete build/. \
+              ${env.DEV_HOST}:/var/www/${env.DEV_SITE}/
           """
         }
-      } }
+      }
     }
   }
+
+  post {
+    cleanup { cleanWs() }
+  }
 }

README.md

@@ -1,32 +1,46 @@
-# Nimbus Site
-
-This repo holds the code for two sites:
-
-* [nimbus.team](https://nimbus.team) - From `master`, built in [CI](https://ci.infra.status.im/job/website/job/nimbus.team/), served from `gh-pages`
-* [dev.nimbus.team](https://dev.nimbus.team) - From `develop`, built in [CI](https://ci.infra.status.im/job/website/job/dev.nimbus.team/), serverd from dev host
-
-There is an `edit` button on each page, which will take you directly to the document you need to edit on the `develop` branch.
-
-The recommended flow is to create a PR against `develop`. We can then allow a large group of people to push directly to `develop` and show their changes on the staging site when asking for review, which should smooth out and speed up the process considerably for everyone. `master` is obviously protected, and will only have changes merged in from `develop` once accepted.
-
-N.B. make sure you've set up [signed commits](https://docs.github.com/en/github/authenticating-to-github/signing-commits) before submitting a PR (this repository requires all commits to be signed). 
-
-## Adding a New Page
-
-If you want to add a page, rather than just edit, you'll need to make sure it appears on the sidebar and is accessible to everyone.
-
-1. Add your page to `source/docs/<your_file_here>.md`
-2. In `source/_data/sidebars.yml` add the appropriate text to the appropriate place.
-3. In `themes/navy/languages/en.yml` edit the sidebars section to make sure that your new text in `sidebars.yml` is rendered correctly.
-
-## Testing locally
-
-Make sure you have [Node.js](https://nodejs.org/) installed first.
-
-1. Open Terminal and navigate to the project root directory,
-2. Run `yarn install`
-3. Run `yarn build`
-4. Run `yarn devel`
-5. Open http://localhost:8000 in a browser
-
-This prevents the need for any global installs, and allows you to live reload any changes you make.
+- [Description](#description)
+- [How to Run Locally](#how-to-run-locally)
+- [Configuration](#configuration)
+- [Customization](#customization)
+
+## Description
+
+This repository contains the content of your documentation website.
+
+## How to Run Locally
+
+1. Clone this repository.
+2. Install the dependencies:
+```bash
+$ yarn
+```
+3. Start and open the website in your browser:
+```bash
+$ yarn start
+```
+
+## Configuration
+Edit the `docusaurus.config.js` file in the repository's root directory, and update the value of the `businessUnit` field in presets section; below is a list of valid values:
+- Logos
+- Codex
+- Waku
+
+Example:
+```js
+presets: [
+  [
+    '@acid-info/logos-docusaurus-preset',
+    {
+      businessUnit: 'Codex',
+    },
+  ],
+],
+```
+
+This is probably enough in most cases, as the Logos plugins will fill in other configurations related to the specified business unit. If you find any error in the information coming from Logos Plugins, please head over to [Logos Docusaurus Plugins](https://github.com/acid-info/logos-docusaurus-plugins) and create an issue.
+
+## Customization
+
+You can find the instructions on adding more documentation sections, localization, and versioning on the [Docusaurus](https://docusaurus.io/docs) website.
+
+> Note that theme customization is limited; for further instructions on customizing your theme, head over to [Logos Docusaurus Theme](https://github.com/acid-info/logos-docusaurus-plugins/tree/main/packages/logos-docusaurus-theme/).