Merge pull request #631 from nhost/docusaurus

New Docs

.github/workflows/build.yml

@@ -2,18 +2,12 @@ name: Build
 on:
   pull_request:
     branches: [master]
-    paths:
-      - '**'
-      - '!docs/**'
-      - '!examples/**'
-      - '!*.md'
+    paths-ignore:
+      - 'docs/**'
   push:
     branches: [master]
-    paths:
-      - '**'
-      - '!docs/**'
-      - '!examples/**'
-      - '!*.md'
+    paths-ignore:
+      - 'docs/**'
   release:
     types: [published]
 env:

.github/workflows/documentation.yml

@@ -0,0 +1,57 @@
+name: documentation
+
+on:
+  pull_request:
+    branches: [master]
+    paths:
+      - 'docs/**'
+  push:
+    branches: [master]
+    paths:
+      - 'docs/**'
+
+jobs:
+  checks:
+    if: github.event_name != 'push'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - name: Test Build
+        run: |
+          if [ -e yarn.lock ]; then
+          yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          npm run build
+  gh-release:
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
+      - name: Release to GitHub Pages
+        env:
+          USE_SSH: true
+          GIT_USER: git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "gh-actions"
+          if [ -e yarn.lock ]; then
+          yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          npm run deploy

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/.prettierrc.js

@@ -0,0 +1 @@
+module.exports = {};

docs/README.md

@@ -1,26 +1,33 @@
----
-home: true
-heroImage: logo.png
-heroText: Hasura Backend Plus
-tagline: Authentication and Object Storage for Hasura
-actionText: Get Started →
-actionLink: /guide/
-features:
-  - title: Hasura
-    details: Works alongside with Hasura GraphQL Engine and seamlessly integrates the recurrent features you're craving for.
-  - title: Authentication
-    details: Comprehensive user accounts management, JWT, optional multi-factor authentication, Hasura claims with roles and custom fields and many more.
-  - title: Storage
-    details: Easy and configurable API for any S3-compatible object storage such as Minio.
-footer: MIT Licensed | Copyright © 2018-present Nhost
----
-
-The easiest way to deploy HBP is with the official [Nhost](https://nhost.io) managed service. Get your perfect configured backend with PostgreSQL, Hasura and Hasura Backend Plus and save yourself hours of maintenance per month.
-
-All [Nhost](https://nhost.io) projects are built on open source software so you can make realtime web and mobile apps fast 🚀.
-
-<div style="text-align:center;">
-  <a href="https://nhost.io/register" target="_blank" >
-    <img src="https://raw.githubusercontent.com/nhost/hasura-backend-plus/master/docs/.vuepress/public/nhost-register-button.png" width="200px" />
-  </a>
-</div>
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```console
+yarn install
+```
+
+## Local Development
+
+```console
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```console
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+```console
+GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.