Skip to content

Commit

Permalink
Initial vitepress migration.
Browse files Browse the repository at this point in the history
  • Loading branch information
reynoldsalec committed Jan 26, 2024
1 parent 871447b commit 8c3b348
Show file tree
Hide file tree
Showing 21 changed files with 1,172 additions and 2,656 deletions.
5 changes: 3 additions & 2 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.temp
.cache
temp
cache
dist
_site
!.vitepress
2 changes: 1 addition & 1 deletion .github/workflows/pr-docs-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:

# Run tests
- name: Run linter
run: npm run docs:lint
run: npm run npm run lint
- name: Test build
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,8 @@ docs/.vuepress/dist

# YARN
yarn.lock
# vitepress thangs
docs/.vitepress/.temp
docs/.vitepress/cache
docs/.vitepress/dist
docs/.vitepress/config.*.timestamp-*-*.*
28 changes: 22 additions & 6 deletions docs/.eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,28 @@
"root": true,
"rules": {
"linebreak-style": 0,
"arrow-parens": ["error",
"arrow-parens": [
"error",
"as-needed"
],
"max-len": ["error", {
"code": 12000,
"ignoreComments": true
}]
}
"max-len": [
"error",
{
"code": 12000,
"ignoreComments": true
}
]
},
"require-jsdoc": [
"error",
{
"require": {
"FunctionDeclaration": false,
"MethodDefinition": false,
"ClassDeclaration": false,
"ArrowFunctionExpression": false,
"FunctionExpression": false
}
}
]
}
56 changes: 56 additions & 0 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
import {createRequire} from 'module';

import {defineConfig} from '@lando/vitepress-theme-default-plus/config';

const require = createRequire(import.meta.url);

const {name, version} = require('../../package.json');
const landoPlugin = name.replace('@lando/', '');

export default defineConfig({
title: 'Lando Dotnet Plugin',
description: 'The offical Lando plugin for Dotnet.',
landoDocs: 3,
landoPlugin,
version,
head: [
['meta', {name: 'viewport', content: 'width=device-width, initial-scale=1'}],
['link', {rel: 'icon', href: '/acquia/favicon.ico', size: 'any'}],
['link', {rel: 'icon', href: '/acquia/favicon.svg', type: 'image/svg+xml'}],
],
themeConfig: {
sidebar: sidebar(),
},
});

function sidebar() {
return [
{
text: 'Introduction',
collapsed: false,
items: [
{text: 'Overview', link: '/'},
{text: 'Installation', link: '/install'},
{text: 'Usage', link: '/config'},
],
},
{
text: 'Contribution',
collapsed: false,
items: [
{text: 'Development', link: '/development'},
{text: 'Team', link: '/team'},
],
},
{
text: 'Help & Support',
collapsed: false,
items: [
{text: 'GitHub', link: 'https://github.com/lando/acquia/issues/new/choose'},
{text: 'Slack', link: 'https://launchpass.com/devwithlando'},
{text: 'Contact Us', link: '/support'},
],
},
{text: 'Examples', link: 'https://github.com/lando/acquia/tree/main/examples'},
];
};
3 changes: 3 additions & 0 deletions docs/.vitepress/theme/index.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import VPLTheme from '@lando/vitepress-theme-default-plus';

export default VPLTheme;
45 changes: 45 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Installation
description: How to install the Lando Dotnet Plugin.
---

# Installation

If you are using Lando 3 then its *highly likely* you already have this plugin as its included by default in most installation pathways. You can verify this by running:

```sh
lando version --component @lando/acquia
```

However if you would like to manually install the plugin, update it to the bleeding edge or install a particular version then use the below.

::: code-group
```sh [lando 3.21+]
lando plugin-add @lando/acquia
```

```sh [hyperdrive]
# @NOTE: This doesn't actaully work yet
hyperdrive install @lando/acquia
```

```sh [docker]
# Ensure you have a global plugins directory
mkdir -p ~/.lando/plugins

# Install plugin
# NOTE: Modify the "npm install @lando/acquia" line to install a particular version eg
# npm install @lando/[email protected]
docker run --rm -it -v ${HOME}/.lando/plugins:/plugins -w /tmp node:18-alpine sh -c \
"npm init -y \
&& npm install @lando/acquia --production --flat --no-default-rc --no-lockfile --link-duplicates \
&& npm install --production --cwd /tmp/node_modules/@lando/acquia \
&& mkdir -p /plugins/@lando \
&& mv --force /tmp/node_modules/@lando/acquia /plugins/@lando/acquia"

# Rebuild the plugin cache
lando --clear
```
:::

You should be able to verify the plugin is installed by running `lando config --path plugins` and checking for `@lando/acquia`. This command will also show you _where_ the plugin is being loaded from.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
20 changes: 5 additions & 15 deletions docs/support.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,11 @@
---
title: Help and Support
description: Get help with and support for the Lando Acquia recipe.
title: Contact Us
description: Get help and support for the Lando ACQUIA Plugin
---

# Help and Support
# Contact Us

## Slack

If you have a question or would like some community support we recommend you [join the Lando community on Slack](https://launchpass.com/devwithlando).

## GitHub

If you'd like to report a bug or submit a feature request then please [use the issue queue](https://github.com/lando/acquia/issues/new/choose) in this repo.

## Contact

If you need priority and dedicated support, expediated bug fixes or more features then please contact us below:
If you need priority and dedicated support, expediated bug fixes or more features then please contact us below.

<form class="netlify" name="contact" method="POST" netflify data-netlify="true">
<input type="hidden" name="form-name" value="contact" />
Expand All @@ -31,4 +21,4 @@ If you need priority and dedicated support, expediated bug fixes or more feature
<p>
<button type="submit">Submit</button>
</p>
</form>
</form>
25 changes: 25 additions & 0 deletions docs/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
description: Learn about the team that made the acquia plugin.
layout: page
title: Team
---

<VPLTeamPage>
<VPLTeamPageTitle>
<template #title>
Team
</template>
<template #lead>
We are the people who brought acquia to Lando.
</template>
</VPLTeamPageTitle>
<VPLTeamMembers :members="members" size="small"/>
</VPLTeamPage>

<script setup>
import {VPLTeamPage, VPLTeamPageTitle, VPLTeamMembers} from '@lando/vitepress-theme-default-plus'
import {useTeam} from '@lando/vitepress-theme-default-plus';

const members = useTeam();

</script>
2 changes: 1 addition & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[build]
base = "./"
publish = "docs/.vuepress/dist"
publish = "docs/.vitepress/dist"
command = "npm run docs:build"

# Sets our asset optimization
Expand Down
Loading

0 comments on commit 8c3b348

Please sign in to comment.