Exploration of new docs build system

.github/workflows/continous-integration.yml

@@ -39,8 +39,8 @@ jobs:
     - name: Run Swagger 🕵️‍♀️
       run: |
         npm install -g swagger-cli
-        swagger-cli validate docs/_static/spec/action-server.yml
-        swagger-cli validate docs/_static/spec/rasa.yml
+        swagger-cli validate docs/static/spec/action-server.yml
+        swagger-cli validate docs/static/spec/rasa.yml
 
   quality:
     name: Code Quality
@@ -55,6 +55,11 @@ jobs:
       with:
         python-version: 3.7
 
+    - name: Set up Node 12.x 🦙
+      uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
+
     - name: Read Poetry Version 🔢
       run: |
         echo "::set-env name=POETRY_VERSION::$(scripts/poetry-version.sh)"
@@ -72,10 +77,17 @@ jobs:
         key: ${{ runner.os }}-poetry-3.7-${{ hashFiles('**/poetry.lock') }}
         restore-keys: ${{ runner.os }}-poetry-3.7
 
+    - name: Load Yarn Cached Packages ⬇
+      uses: actions/cache@v1
+      with:
+        path: docs/node_modules
+        key: ${{ runner.os }}-yarn-12.x-${{ hashFiles('docs/yarn.lock') }}
+        restore-keys: ${{ runner.os }}-yarn-12.x
+
     - name: Install Dependencies 📦
       run: |
         sudo apt-get -y install libpq-dev
-        make install-full
+        make install-full install-docs
 
     - name: Lint Code 🎎
       run: make lint
@@ -89,24 +101,10 @@ jobs:
       # trying to run the `rasa` command once before the docs build.
       run: poetry run rasa --help
 
-# DOES NOT WORK YET DUE TO TENSORFLOW 1.5 (some issue with no tensorflow-cpu verison)
-#  -> should work with 2.0 and replace the below "Test Docs":
-#
-#    - name: Test Docs
-#      uses: ammaraskar/sphinx-action@0.3
-#      with:
-#        docs-folder: "docs/"
-#        repo-token: "${{ secrets.GITHUB_TOKEN }}"
-#        build-command: "make SPHINXOPTS=\"-W --keep-going -A html_theme=rasabaster\" html"
-#        pre-build-command: "apt-get update -y && apt-get install -y git"
-
     - name: Test Docs 📃
       run: |
-        make install-full
         poetry run python -c "from scripts import release; release.generate_changelog('major.minor.patch')"
-        export SPHINXBUILD=$(poetry run which sphinx-build)
-        cd docs && make SPHINXBUILD=$SPHINXBUILD SPHINXOPTS="-W --keep-going -A html_theme=rasabaster" html && make SPHINXBUILD=$SPHINXBUILD linkcheck
-
+        make docs
 
   test:
     name: Run Tests
@@ -275,9 +273,7 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
         GITHUB_TAG=${GITHUB_TAG/refs\/tags\//}
-        sudo apt-get update
-        sudo apt-get -y install pandoc
-        pip install -U github3.py pypandoc
+        pip install -U github3.py
         python3 scripts/publish_gh_release_notes.py
         ./scripts/ping_slack_about_package_release.sh
 

.github/workflows/documentation.yml

@@ -3,7 +3,6 @@ name: Publish Documentation
 on:
   push:
     branches:
-    - '[0-9]+.[0-9]+.x'
     - 'master'
     tags:
     - '**'
@@ -13,6 +12,10 @@ on:
 #                    `ssh-keygen -t rsa -b 4096 -C "Github CI Docs Key" -N "" -f key`
 # - GITHUB_TOKEN: (default, from github actions)
 
+env:
+  DOCS_FOLDER: docs
+  DOCS_BRANCH: documentation
+
 jobs:
   docs:
     name: Build Docs
@@ -28,6 +31,11 @@ jobs:
       with:
         python-version: 3.6
 
+    - name: Set up Node 12.x 🦙
+      uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
+
     - name: Read Poetry Version 🔢
       run: |
         echo "::set-env name=POETRY_VERSION::$(scripts/poetry-version.sh)"
@@ -45,12 +53,23 @@ jobs:
         key: ${{ runner.os }}-poetry-3.6-non-full-${{ hashFiles('**/poetry.lock') }}
         restore-keys: ${{ runner.os }}-poetry-3.6-non-full
 
+    - name: Load Yarn Cached Packages ⬇
+      uses: actions/cache@v1
+      with:
+        path: docs/node_modules
+        key: ${{ runner.os }}-yarn-12.x-${{ hashFiles('docs/yarn.lock') }}
+        restore-keys: ${{ runner.os }}-yarn-12.x
+
     - name: Install Dependencies 📦
-      run: make install
+      run: make install install-docs
+
+    - name: Pre-build Docs 🧶
+      run: cd $DOCS_FOLDER && poetry run yarn pre-build
 
     - name: Build & Publish Docs 🏃‍♀️
       env:
         GITHUB_DOCS_KEY: ${{ secrets.GITHUB_DOCS_KEY }}
+        TMP_DOCS_FOLDER: ~/tmp-documentation
       run: |
         eval "$(ssh-agent -s)"; touch docs_key; chmod 0600 docs_key
         echo "$GITHUB_DOCS_KEY" > "docs_key"
@@ -60,4 +79,4 @@ jobs:
         git config --global user.name "GitHub CI"
         git remote set-url --push origin "git@github.com:${{github.repository}}"
 
-        poetry run sphinx-versioning push docs docs . -- -b dirhtml -A html_theme=rasabaster
+        ./scripts/push_docs_to_branch.sh

.gitignore

@@ -18,8 +18,6 @@ venv
 .pytype
 dist/
 pip-wheel-metadata
-docs/nlu/_build
-docs/_build
 server/
 scala/
 mongodb/
@@ -47,15 +45,11 @@ tmp_training_data.json
 models/
 .mypy_cache/
 *.tar.gz
-docs/nlu/key
-docs/nlu/key.pub
 secrets.tar
 .pytest_cache
-src
 test_download.zip
 bower_components/
 build/lib/
-docs/core/_build
 /models/
 node_modules/
 npm-debug.log
@@ -72,8 +66,6 @@ examples/moodbot/errors.json
 examples/formbot/models*
 examples/concertbot/models*
 examples/moodbot/models*
-docs/core/key
-docs/core/key.pub
 failed_stories.md
 errors.json
 pip-wheel-metadata/*
@@ -88,3 +80,7 @@ rasa.db-wal
 env
 .dir-locals.el
 .history
+docs/.docusaurus
+docs/docs/variables.json
+docs/docs/sources/
+docs/docs/changelog.mdx

.typo-ci.yml

@@ -22,8 +22,10 @@ excluded_files:
   - "*.yaml"
   - "*.html"
   - "*.json"
+  - "*.lock"
+  - "*.js"
   - "*.md"
-  - "CHANGELOG.rst"
+  - "CHANGELOG.mdx"
   - "CODE_OF_CONDUCT.md"
   - "CONTRIBUTING.md"
   - "Dockerfile"
@@ -32,7 +34,6 @@ excluded_files:
   - "NOTICE"
   - "README.md"
   - "cloudbuild.yaml"
-  - "poetry.lock"
   - "pyproject.toml"
   - "secrets.tar.enc"
   - "setup.cfg"
@@ -70,6 +71,7 @@ excluded_words:
   - daksh
   - db's
   - deque
+  - docusaurus
   - non-latin
   - deduplicate
   - deduplication
@@ -154,5 +156,8 @@ excluded_words:
   - unschedule
   - wsgi
   - ruamel
+  - prototyper
+  - hallo
+  - crypto
 
 spellcheck_filenames: false