#130: Doc PR tests

.eslintrc.json

@@ -3,8 +3,11 @@
     "node": true,
     "mocha": true
   },
+  "parser": "@babel/eslint-parser",
   "parserOptions": {
-    "ecmaVersion": 6
+    "sourceType": "module",
+    "ecmaVersion": 8,
+    "requireConfigFile": false
   },
   "extends": "google",
   "rules": {

.github/workflows/pr-docs-tests.yml

@@ -0,0 +1,31 @@
+name: Run Docs Tests
+
+on:
+  pull_request:
+
+jobs:
+  unit-tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-20.04
+        node-version:
+          - '14'
+    steps:
+      # Install deps and cache
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Install node ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: yarn
+      - name: Install Yarn dependencies
+        run: yarn install --prefer-offline --frozen-lockfile
+
+      # Run tests
+      - name: Run linter
+        run: yarn docs:lint
+      - name: Test build
+        run: yarn docs:build

app.js

@@ -140,7 +140,7 @@ module.exports = (app, lando) => {
       // Add relationships keyed by the service name
       app.platformsh.relationships = pshconf.parseRelationships(
         platformConfig.applications,
-        app.platformsh.closestOpenCache
+        app.platformsh.closestOpenCache,
       );
       app.log.verbose('determined platformsh relationships');
       app.log.silly('platformsh relationships are', app.platformsh.relationships);
@@ -153,7 +153,7 @@ module.exports = (app, lando) => {
       // Figure out what relationships are pullable and not
       app.platformsh.closestApp.syncableRelationships = pshconf.getSyncableRelationships(
         app.platformsh.closestApp.relationships,
-        app.platformsh.services
+        app.platformsh.services,
       );
 
       // Go through our platform config and generate an array of configuration files for each
@@ -258,7 +258,7 @@ module.exports = (app, lando) => {
           serviceTooling: tooling.getServiceTooling(
             application.serviceContainers,
             application.openData,
-            application.name
+            application.name,
           ),
         }))
         // Merge it all together

docs/.eslintrc.json

@@ -1,7 +1,9 @@
 {
+  "parser": "@babel/eslint-parser",
   "parserOptions": {
     "sourceType": "module",
-    "ecmaVersion": 6
+    "ecmaVersion": 8,
+    "requireConfigFile": false
   },
   "extends": [
     "plugin:vue/recommended",

docs/.vuepress/config.js

@@ -1,17 +1,25 @@
 const {path} = require('@vuepress/utils');
+const yaml = require('js-yaml');
+const fs = require('fs');
 
 module.exports = {
   lang: 'en-US',
   title: 'Lando',
   description: 'Lando Platform.sh Plugin Documentation',
   head: [
     ['link', {rel: 'icon', href: '/favicon.ico'}],
-    ['link', {rel: 'stylesheet', href: '/styles/overrides.css'}],
     ['link', {rel: 'stylesheet', href: '//fonts.googleapis.com/css?family=Poppins:700|Source+Sans+Pro&display=swap'}],
   ],
-  theme: path.resolve(__dirname, 'theme'),
+  theme: '@lando/vuepress-theme-lando-docs',
   themeConfig: {
     logo: '/images/logo-pink-small.png',
+    repo: 'lando/platformsh',
+    docsDir: 'docs',
+    docsBranch: 'main',
+    sponsors: yaml.load(fs.readFileSync(path.resolve(__dirname, 'public') + '/api/sponsors.yml', 'utf8')),
+    // showSponsors: ['platformsh'],
+    showCarbonAds: true,
+    showSponsors: true,
     navbar: [
       {text: 'Getting Started', link: 'https://docs.lando.dev/basics/'},
       {text: 'Config', link: '/config/lando.md'},

docs/.vuepress/public/api/sponsors.yml

@@ -0,0 +1,16 @@
+- name: Platform.sh
+  id: platformsh
+  url: https://platform.sh
+  logo: https://lando.dev/images/platform_sh_logo.png
+- name: amazee.io
+  id: amazeeio
+  url: https://www.amazee.io/
+  logo: https://lando.dev/images/amazee_io_logo.png
+- name: Pantheon
+  id: pantheon
+  url: https://pantheon.io/
+  logo: https://lando.dev/images/pantheon_logo.png
+- name: Blackmesh by Contegix
+  id: blackmesh
+  url: https://www.blackmesh.com/
+  logo: https://lando.dev/images/blackmesh_logo.png