Skip to content
This repository was archived by the owner on Nov 14, 2024. It is now read-only.

Commit 448ecc6

Browse files
pirogpirog
committedFeb 9, 2024
fix linting, testing, removing dangling yarn threads
·
v4.1.0
1 parent de06459 commit 448ecc6

File tree

8 files changed

+263
-3176
lines changed

8 files changed

+263
-3176
lines changed
 

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

+12-16
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,31 @@
1-
name: Documentation tests
1+
name: Run Docs Tests
22

33
on:
44
pull_request:
55

66
jobs:
7-
docs-tests:
7+
unit-tests:
88
runs-on: ${{ matrix.os }}
9-
env:
10-
TERM: xterm
119
strategy:
1210
matrix:
1311
os:
14-
- ubuntu-20.04
12+
- ubuntu-22.04
1513
node-version:
16-
- '16'
14+
- '18'
1715
steps:
1816
# Install deps and cache
19-
# Eventually it would be great if these steps could live in a separate YAML file
20-
# that could be included in line to avoid code duplication
2117
- name: Checkout code
2218
uses: actions/checkout@v3
2319
- name: Install node ${{ matrix.node-version }}
2420
uses: actions/setup-node@v3
2521
with:
2622
node-version: ${{ matrix.node-version }}
27-
cache: yarn
28-
- name: Install Yarn dependencies
29-
run: yarn install --prefer-offline --frozen-lockfile
23+
cache: npm
24+
- name: Install dependencies
25+
run: npm clean-install --prefer-offline --frozen-lockfile
3026

31-
# Run doc tests
32-
- name: Lint docs code
33-
run: yarn lint
34-
- name: Build Docs
35-
run: yarn build
27+
# Run tests
28+
- name: Run linter
29+
run: npm run lint
30+
- name: Test build
31+
run: npm run build

‎.gitignore

+10-12
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,21 @@ env.yml
2626
lando.env
2727
.lando.local.yml
2828

29-
# Build dirs
30-
build
31-
dist
32-
_docs3
33-
3429
# coverage reporting
3530
.nyc_output
3631
coverage/
3732

38-
# Vuepress
33+
# docs
34+
build
35+
dist
36+
_docs3
3937
.temp
4038
.cache
41-
dist
4239
_site
40+
dist
41+
cache
42+
temp
43+
config.*.timestamp-*-*.*
4344

44-
# vitepress thangs
45-
.vitepress/.temp
46-
.vitepress/cache
47-
.vitepress/dist
48-
.vitepress/config.*.timestamp-*-*.*
45+
# yarn
46+
yarn.lock

‎.lando.yml

+4-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name: lando-docs
22
services:
33
node:
4-
type: node:14
4+
type: node:18
55
build:
6-
- yarn install
6+
- npm install
77
scanner: false
88
ssl: false
99
sslExpose: false
@@ -13,10 +13,6 @@ services:
1313
tooling:
1414
node:
1515
service: node
16-
yarn:
16+
npm:
1717
service: node
18-
dev:
19-
service: node
20-
cmd: yarn dev --port 8011
21-
env:
22-
DEBUG: "@lando/*"
18+

‎.vitepress/config.mjs

+77-84
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
import {createRequire} from 'module';
2-
31
import {defineConfig} from '@lando/vitepress-theme-default-plus/config';
42

5-
const require = createRequire(import.meta.url);
6-
7-
const {version} = require('../package.json');
8-
93
export default defineConfig({
104
title: 'Lando',
115
description: 'Documentation.',
126
landoDocs: 3,
13-
base: '/',
147
head: [
158
['meta', {name: 'viewport', content: 'width=device-width, initial-scale=1'}],
169
['link', {rel: 'icon', href: '/favicon.ico', size: 'any'}],
@@ -48,99 +41,99 @@ export default defineConfig({
4841
text: 'Guides',
4942
collapsed: true,
5043
items: [
51-
{"link": "/guides/access-by-other-devices.html", "text": "Accessing Lando from Other Devices on Your Local Network"},
52-
{"link": "/guides/db-export.html", "text": "SQL Export"},
53-
{"link": "/guides/db-import.html", "text": "SQL Import"},
54-
{"link": "/guides/external-access.html", "text": "Accessing Your Services Externally"},
55-
{"link": "/guides/how-do-i-configure-a-lando-recipe.html", "text": "How do I configure a Lando Recipe?"},
56-
{"link": "/guides/how-do-i-set-the-timezone-of-a-lando-service.html", "text": "How do I set the timezone of a Lando service?"},
57-
{"link": "/guides/lando-info.html", "text": "Using $LANDO_INFO"},
58-
{"link": "/guides/lando-phpstorm.html", "text": "Lando + PhpStorm + Xdebug"},
59-
{"link": "/guides/lando-with-vscode.html", "text": "Using Lando with VSCode"},
60-
{"link": "/guides/offline-dev.html", "text": "Developing offline"},
61-
{"link": "/guides/overriding-a-service-version.html", "text": "Overriding a Service Version or Image"},
62-
{"link": "/guides/updating-to-rc2.html", "text": "Updating to 3.0.0-rc.2+"},
63-
{"link": "/guides/lando-corporate-network-tips.html", "text": "Lando in Corporate Network Environments"},
64-
{"link": "/guides/accessibility.html", "text": "Accessibility and Lando"}
44+
{link: '/guides/access-by-other-devices.html', text: 'Accessing Lando from Other Devices on Your Local Network'},
45+
{link: '/guides/db-export.html', text: 'SQL Export'},
46+
{link: '/guides/db-import.html', text: 'SQL Import'},
47+
{link: '/guides/external-access.html', text: 'Accessing Your Services Externally'},
48+
{link: '/guides/how-do-i-configure-a-lando-recipe.html', text: 'How do I configure a Lando Recipe?'},
49+
{link: '/guides/how-do-i-set-the-timezone-of-a-lando-service.html', text: 'How do I set the timezone of a Lando service?'},
50+
{link: '/guides/lando-info.html', text: 'Using $LANDO_INFO'},
51+
{link: '/guides/lando-phpstorm.html', text: 'Lando + PhpStorm + Xdebug'},
52+
{link: '/guides/lando-with-vscode.html', text: 'Using Lando with VSCode'},
53+
{link: '/guides/offline-dev.html', text: 'Developing offline'},
54+
{link: '/guides/overriding-a-service-version.html', text: 'Overriding a Service Version or Image'},
55+
{link: '/guides/updating-to-rc2.html', text: 'Updating to 3.0.0-rc.2+'},
56+
{link: '/guides/lando-corporate-network-tips.html', text: 'Lando in Corporate Network Environments'},
57+
{link: '/guides/accessibility.html', text: 'Accessibility and Lando'},
6558
],
6659
},
6760
{
6861
text: 'Troubleshooting',
6962
collapsed: true,
7063
items: [
71-
{"link": "/help/logs.html", "text": "Accessing Logs"},
72-
{"link": "/help/wkbox.html", "text": "Using Lando with Kalabox"},
73-
{"link": "/help/updating.html", "text": "Updating"},
74-
{"link": "/help/purging-containers.html", "text": "Purging Containers"},
75-
{"link": "/help/dns-rebind.html", "text": "DNS Rebinding Protection"},
76-
{"link": "/help/win-file-upload.html", "text": "Uploading Files in Windows"},
77-
{"link": "/help/file-sync.html", "text": "File syncing issues"},
78-
{"link": "/help/win-also-vb.html", "text": "Windows is also running VirtualBox"},
79-
{"link": "/help/proxy", "text": "Running Lando behind a Proxy"},
80-
{"link": "/help/switching-dbs.html", "text": "Switching Database Configuration"}
64+
{link: '/help/logs.html', text: 'Accessing Logs'},
65+
{link: '/help/wkbox.html', text: 'Using Lando with Kalabox'},
66+
{link: '/help/updating.html', text: 'Updating'},
67+
{link: '/help/purging-containers.html', text: 'Purging Containers'},
68+
{link: '/help/dns-rebind.html', text: 'DNS Rebinding Protection'},
69+
{link: '/help/win-file-upload.html', text: 'Uploading Files in Windows'},
70+
{link: '/help/file-sync.html', text: 'File syncing issues'},
71+
{link: '/help/win-also-vb.html', text: 'Windows is also running VirtualBox'},
72+
{link: '/help/proxy', text: 'Running Lando behind a Proxy'},
73+
{link: '/help/switching-dbs.html', text: 'Switching Database Configuration'},
8174
],
8275
},
8376
{
8477
text: 'Contributing',
8578
collapsed: true,
8679
items: [
87-
{"link": "/contrib/index.html", "text": "Getting Involved"},
88-
{"link": "/contrib/coder.html", "text": "Coding"},
89-
{"link": "/contrib/evangelist.html", "text": "Evangelizing"},
90-
{"link": "/contrib/sponsoring.html", "text": "Sponsoring"}
80+
{link: '/contrib/index.html', text: 'Getting Involved'},
81+
{link: '/contrib/coder.html', text: 'Coding'},
82+
{link: '/contrib/evangelist.html', text: 'Evangelizing'},
83+
{link: '/contrib/sponsoring.html', text: 'Sponsoring'},
9184
],
9285
},
9386
],
9487
},
9588
},
9689
});
9790

98-
function configSideBar() {
99-
return [
100-
{
101-
text: 'Theme Configuration',
102-
collapsed: false,
103-
items: [
104-
{text: 'Configuration', link: '/config/config'},
105-
{text: 'Frontmatter', link: '/config/frontmatter'},
106-
{text: 'useCollection()', link: '/composables/use-collection'},
107-
{text: 'useTeam()', link: '/composables/use-team'},
108-
],
109-
},
110-
{
111-
text: 'Pages',
112-
collapsed: false,
113-
items: [
114-
{text: 'Collections', link: '/pages/collections'},
115-
{text: 'Teams', link: '/pages/teams'},
116-
],
117-
},
118-
{
119-
text: 'Global Components',
120-
collapsed: false,
121-
items: [
122-
{text: 'Jobs', link: '/components/jobs'},
123-
{text: 'MailChimp', link: '/components/mailchimp'},
124-
{text: 'Sponsor', link: '/components/sponsors'},
125-
{text: 'YouTube', link: '/components/youtube'},
126-
],
127-
},
128-
{
129-
text: 'Markdown Containers',
130-
collapsed: false,
131-
items: [
132-
{text: 'Admonitions', link: '/markdown/admonitions'},
133-
{text: 'Alignments', link: '/markdown/alignments'},
134-
{text: 'Boxes', link: '/markdown/boxes'},
135-
{text: 'Cards', link: '/markdown/cards'},
136-
{text: 'Columns', link: '/markdown/columns'},
137-
{text: 'Highlights', link: '/markdown/highlights'},
138-
{text: 'Tabs', link: '/markdown/tabs'},
139-
{text: 'Thumbnails', link: '/markdown/thumbnails'},
140-
{text: 'Advanced', link: '/guides/advanced-markdown'},
141-
],
142-
},
143-
{text: 'Blog', link: '/blog'},
144-
{text: 'Guides', link: '/guides'},
145-
];
146-
}
91+
// function configSideBar() {
92+
// return [
93+
// {
94+
// text: 'Theme Configuration',
95+
// collapsed: false,
96+
// items: [
97+
// {text: 'Configuration', link: '/config/config'},
98+
// {text: 'Frontmatter', link: '/config/frontmatter'},
99+
// {text: 'useCollection()', link: '/composables/use-collection'},
100+
// {text: 'useTeam()', link: '/composables/use-team'},
101+
// ],
102+
// },
103+
// {
104+
// text: 'Pages',
105+
// collapsed: false,
106+
// items: [
107+
// {text: 'Collections', link: '/pages/collections'},
108+
// {text: 'Teams', link: '/pages/teams'},
109+
// ],
110+
// },
111+
// {
112+
// text: 'Global Components',
113+
// collapsed: false,
114+
// items: [
115+
// {text: 'Jobs', link: '/components/jobs'},
116+
// {text: 'MailChimp', link: '/components/mailchimp'},
117+
// {text: 'Sponsor', link: '/components/sponsors'},
118+
// {text: 'YouTube', link: '/components/youtube'},
119+
// ],
120+
// },
121+
// {
122+
// text: 'Markdown Containers',
123+
// collapsed: false,
124+
// items: [
125+
// {text: 'Admonitions', link: '/markdown/admonitions'},
126+
// {text: 'Alignments', link: '/markdown/alignments'},
127+
// {text: 'Boxes', link: '/markdown/boxes'},
128+
// {text: 'Cards', link: '/markdown/cards'},
129+
// {text: 'Columns', link: '/markdown/columns'},
130+
// {text: 'Highlights', link: '/markdown/highlights'},
131+
// {text: 'Tabs', link: '/markdown/tabs'},
132+
// {text: 'Thumbnails', link: '/markdown/thumbnails'},
133+
// {text: 'Advanced', link: '/guides/advanced-markdown'},
134+
// ],
135+
// },
136+
// {text: 'Blog', link: '/blog'},
137+
// {text: 'Guides', link: '/guides'},
138+
// ];
139+
// }

‎netlify.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[build]
22
base = "./"
3-
publish = "dist"
4-
command = "yarn build"
3+
publish = "docs/.vitepress/dist"
4+
command = "npm run build"
55

66
# Sets our asset optimization
77
[build.processing.css]

‎package-lock.json

+152-410
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+6-8
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@lando/docs",
33
"description": "Lando Docs Repo.",
44
"version": "4.0.1",
5-
"author": "John Ouellet @labboy0276",
5+
"author": "Mike Pirog @pirog",
66
"license": "GPL-3.0",
77
"repository": "lando/docs",
88
"bugs": "https://github.com/lando/docs/issues/new/choose",
@@ -17,22 +17,20 @@
1717
},
1818
"main": "index.js",
1919
"scripts": {
20-
"dev": "vitepress dev .",
2120
"build": "vitepress build .",
22-
"preview": "vitepress preview .",
23-
"lint": "eslint .",
24-
"release": "bump --prompt --tag --all --push"
21+
"dev": "vitepress dev .",
22+
"lint": "eslint . --ext .js --ext .mjs ",
23+
"preview": "vitepress preview ."
2524
},
2625
"devDependencies": {
2726
"@babel/eslint-parser": "^7.16.0",
27+
"@lando/vitepress-theme-default-plus": "^1.0.0-beta.20",
2828
"babel-eslint": "^10.1.0",
2929
"eslint": "^7.32.0",
3030
"eslint-config-google": "^0.9.1",
31-
"eslint-plugin-vue": "^8.0.3",
32-
"version-bump-prompt": "^4.2.1"
31+
"eslint-plugin-vue": "^8.0.3"
3332
},
3433
"dependencies": {
35-
"@lando/vitepress-theme-default-plus": "^1.0.0-beta.19",
3634
"vitepress": "^1.0.0-rc.40"
3735
}
3836
}

‎yarn.lock

-2,636
This file was deleted.

0 commit comments

Comments
 (0)
This repository has been archived.