From 5235036ba504ca4792224cf2c0bb5b8108502041 Mon Sep 17 00:00:00 2001 From: Mike Pirog Date: Wed, 3 Nov 2021 09:02:45 -0400 Subject: [PATCH 01/16] #130: Doc PR tests --- .github/workflows/pr-docs-tests.yml | 31 +++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/workflows/pr-docs-tests.yml diff --git a/.github/workflows/pr-docs-tests.yml b/.github/workflows/pr-docs-tests.yml new file mode 100644 index 0000000..f568096 --- /dev/null +++ b/.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 From 12afb20feac04192fd5e439ea6c1a4f5d10a56a6 Mon Sep 17 00:00:00 2001 From: Mike Pirog Date: Wed, 3 Nov 2021 09:06:36 -0400 Subject: [PATCH 02/16] #130: Fix busted CarbonAds styling --- docs/.vuepress/config.js | 1 - docs/.vuepress/theme/components/CarbonAds.vue | 3 --- 2 files changed, 4 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 3236eff..37ce31f 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -6,7 +6,6 @@ module.exports = { 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'), diff --git a/docs/.vuepress/theme/components/CarbonAds.vue b/docs/.vuepress/theme/components/CarbonAds.vue index 9061bd2..536d3b2 100644 --- a/docs/.vuepress/theme/components/CarbonAds.vue +++ b/docs/.vuepress/theme/components/CarbonAds.vue @@ -1,6 +1,3 @@ - \ No newline at end of file diff --git a/docs/.vuepress/theme/index.js b/docs/.vuepress/theme/index.js index 8b517bb..f60b6a6 100644 --- a/docs/.vuepress/theme/index.js +++ b/docs/.vuepress/theme/index.js @@ -9,7 +9,7 @@ module.exports = (options, app) => { showCarbonAds: true, // Shows the special sponsors on the right // Can be true|false|or a list of sponsors to show - // showSponsors: ['platformsh'], + showSponsors: true, // Metadata for our sponsors // sponsors: }; diff --git a/docs/.vuepress/theme/layouts/Layout.vue b/docs/.vuepress/theme/layouts/Layout.vue index f47c587..fa9cbfe 100644 --- a/docs/.vuepress/theme/layouts/Layout.vue +++ b/docs/.vuepress/theme/layouts/Layout.vue @@ -3,6 +3,9 @@ + @@ -10,12 +13,40 @@ import { computed } from 'vue' import ParentLayout from '@vuepress/theme-default/lib/client/layouts/Layout.vue' import CarbonAds from '../components/CarbonAds.vue'; +import Sponsors from '../components/Sponsors.vue'; import { useThemeData } from '@vuepress/plugin-theme-data/lib/client' // Get theme data const themeData = useThemeData(); // Get the config from themedata const {showCarbonAds = true} = themeData.value; +const {showSponsors = true} = themeData.value; +const sponsors = [ + { + "name": "Platform.sh", + "type": "patriot", + "url": "https://platform.sh", + "logo": "https://lando.dev/images/platform_sh_logo.png" + }, + { + "name": "amazee.io", + "type": "patriot", + "url": "https://www.amazee.io/", + "logo": "https://lando.dev/images/amazee_io_logo.png" + }, + { + "name": "Pantheon", + "type": "patriot", + "url": "https://pantheon.io/", + "logo": "https://lando.dev/images/pantheon_logo.png" + }, + { + "name": "Blackmesh by Contegix", + "type": "patriot", + "url": "https://www.blackmesh.com/", + "logo": "https://lando.dev/images/blackmesh_logo.png" + }, +]; From c47ecaeac693b8fee443546ed83803b5ce168a6b Mon Sep 17 00:00:00 2001 From: John Ouellet Date: Wed, 3 Nov 2021 14:52:50 -0400 Subject: [PATCH 06/16] #130 convert components to use vue3 setup style --- docs/.vuepress/config.js | 32 +++++++++++++++++++- docs/.vuepress/theme/components/Sponsors.vue | 32 +++++++++++++------- docs/.vuepress/theme/layouts/Layout.vue | 28 +---------------- 3 files changed, 53 insertions(+), 39 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index c1ed0eb..74ed900 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -12,9 +12,39 @@ module.exports = { themeConfig: { logo: '/images/logo-pink-small.png', repo: 'lando/platformsh', + sponsors: [ + { + "name": "Platform.sh", + "id": "platformsh", + "type": "patriot", + "url": "https://platform.sh", + "logo": "https://lando.dev/images/platform_sh_logo.png" + }, + { + "name": "amazee.io", + "id": "amazeeio", + "type": "patriot", + "url": "https://www.amazee.io/", + "logo": "https://lando.dev/images/amazee_io_logo.png" + }, + { + "name": "Pantheon", + "id": "pantheon", + "type": "patriot", + "url": "https://pantheon.io/", + "logo": "https://lando.dev/images/pantheon_logo.png" + }, + { + "name": "Blackmesh by Contegix", + "id": "blackmesh", + "type": "patriot", + "url": "https://www.blackmesh.com/", + "logo": "https://lando.dev/images/blackmesh_logo.png" + } + ], docsDir: 'docs', docsBranch: 'main', - showSponsors: ['Platform.sh'], + showSponsors: ['platformsh'], navbar: [ {text: 'Getting Started', link: 'https://docs.lando.dev/basics/'}, {text: 'Config', link: '/config/lando.md'}, diff --git a/docs/.vuepress/theme/components/Sponsors.vue b/docs/.vuepress/theme/components/Sponsors.vue index d775739..76a7907 100644 --- a/docs/.vuepress/theme/components/Sponsors.vue +++ b/docs/.vuepress/theme/components/Sponsors.vue @@ -1,9 +1,9 @@