Skip to content

Commit c3e0712

Browse files
author
Thomas Kosiewski
committed
Added pro docs switch and links to pro docs
Signed-off-by: Thomas Kosiewski <[email protected]>
1 parent b4ef578 commit c3e0712

File tree

16 files changed

+280
-522
lines changed

16 files changed

+280
-522
lines changed

Diff for: .editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ charset = utf-8
1111
trim_trailing_whitespace = true
1212
insert_final_newline = true
1313

14-
[*.{sh,yaml,yml,json}]
14+
[*.{sh,yaml,yml,json,js,ts}]
1515
indent_style = space
1616
indent_size = 2
1717

Diff for: .github/workflows/e2e.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,11 @@ jobs:
150150
go-version: "1.21"
151151
cache: false
152152

153+
- uses: azure/setup-helm@v3
154+
name: Setup Helm
155+
with:
156+
version: "v3.11.0"
157+
153158
- name: Set up kind k8s cluster
154159
uses: engineerd/[email protected]
155160
with:

Diff for: Justfile

+6
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,9 @@ e2e distribution="k3s" path="./test/e2e" multinamespace="false": create-kind &&
116116
cli version="0.0.0" *ARGS="":
117117
RELEASE_VERSION={{ version }} go generate -tags embed_charts ./...
118118
go run -tags embed_charts -mod vendor -ldflags "-X main.version={{ version }}" ./cmd/vclusterctl/main.go {{ ARGS }}
119+
120+
# --- Docs ---
121+
122+
# Version the docs for the given version
123+
docs-version id="pro" version="1.0.0":
124+
yarn docusaurus docs:version {{version}}

Diff for: docs/docusaurus.config.js

+41-45
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,55 @@
1-
__webpack_public_path__ = "/docs/"
1+
__webpack_public_path__ = "/docs/";
22

33
module.exports = {
4-
title: 'vcluster docs | Virtual Clusters for Kubernetes',
5-
tagline: 'Virtual Clusters for Kubernetes',
6-
url: 'https://vcluster.com',
4+
title: "vcluster docs | Virtual Clusters for Kubernetes",
5+
tagline: "Virtual Clusters for Kubernetes",
6+
url: "https://vcluster.com",
77
baseUrl: __webpack_public_path__,
8-
favicon: '/media/vcluster_symbol.svg',
9-
organizationName: 'loft-sh', // Usually your GitHub org/user name.
10-
projectName: 'vcluster', // Usually your repo name.
8+
favicon: "/media/vcluster_symbol.svg",
9+
organizationName: "loft-sh", // Usually your GitHub org/user name.
10+
projectName: "vcluster", // Usually your repo name.
1111
themeConfig: {
1212
colorMode: {
13-
defaultMode: 'light',
13+
defaultMode: "light",
1414
disableSwitch: false,
1515
respectPrefersColorScheme: true,
1616
},
1717
navbar: {
1818
logo: {
19-
alt: 'vcluster',
20-
src: '/media/vCluster_horizontal-orange.svg',
21-
href: 'https://vcluster.com/',
22-
target: '_self',
19+
alt: "vcluster",
20+
src: "/media/vCluster_horizontal-orange.svg",
21+
href: "https://vcluster.com/",
22+
target: "_self",
2323
},
2424
items: [
2525
{
26-
href: 'https://vcluster.com/',
27-
label: 'Website',
28-
position: 'left',
29-
target: '_self'
26+
href: "https://vcluster.com/",
27+
label: "Website",
28+
position: "left",
29+
target: "_self",
3030
},
3131
{
32-
to: '/docs/what-are-virtual-clusters',
33-
label: 'Docs',
34-
position: 'left'
32+
label: "Docs",
33+
position: "left",
34+
to: "/",
3535
},
3636
{
37-
href: 'https://loft.sh/blog',
38-
label: 'Blog',
39-
position: 'left',
40-
target: '_self'
37+
href: "https://loft.sh/blog",
38+
label: "Blog",
39+
position: "left",
40+
target: "_self",
4141
},
4242
{
43-
href: 'https://slack.loft.sh/',
44-
className: 'slack-link',
45-
'aria-label': 'Slack',
46-
position: 'right',
43+
href: "https://slack.loft.sh/",
44+
className: "slack-link",
45+
"aria-label": "Slack",
46+
position: "right",
4747
},
4848
{
49-
href: 'https://github.com/loft-sh/vcluster',
50-
className: 'github-link',
51-
'aria-label': 'GitHub',
52-
position: 'right',
49+
href: "https://github.com/loft-sh/vcluster",
50+
className: "github-link",
51+
"aria-label": "GitHub",
52+
position: "right",
5353
},
5454
],
5555
},
@@ -58,41 +58,37 @@ module.exports = {
5858
apiKey: "42375731adc726ebb99849e9051aa9b4",
5959
indexName: "vcluster",
6060
placeholder: "Search...",
61-
algoliaOptions: {}
61+
algoliaOptions: {},
6262
},
6363
footer: {
64-
style: 'light',
64+
style: "light",
6565
links: [],
6666
copyright: `Copyright © ${new Date().getFullYear()} <a href="https://loft.sh/">Loft Labs, Inc.</a>`,
6767
},
6868
},
6969
presets: [
7070
[
71-
'@docusaurus/preset-classic',
71+
"@docusaurus/preset-classic",
7272
{
7373
docs: {
74-
path: 'pages',
75-
routeBasePath: '/',
76-
sidebarPath: require.resolve('./sidebars.js'),
77-
editUrl:
78-
'https://github.com/loft-sh/vcluster/edit/main/docs/',
74+
path: "pages",
75+
routeBasePath: "/",
76+
sidebarPath: require.resolve("./sidebars.js"),
77+
editUrl: "https://github.com/loft-sh/vcluster/edit/main/docs/",
7978
},
8079
theme: {
81-
customCss: require.resolve('./src/css/custom.css'),
80+
customCss: require.resolve("./src/css/custom.css"),
8281
},
8382
},
8483
],
8584
],
86-
plugins: [],
8785
scripts: [
8886
{
89-
src:
90-
'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
87+
src: "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
9188
async: true,
9289
},
9390
{
94-
src:
95-
'/docs/js/custom.js',
91+
src: "/docs/js/custom.js",
9692
async: true,
9793
},
9894
],

Diff for: docs/pages/architecture/control_plane/isolated_control_planes.mdx

-76
This file was deleted.

Diff for: docs/pages/community.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ sidebar_label: Community
55

66
### Slack
77

8-
You can join the community and reachout to us regarding any queries and disscussion on the community slack channel at https://slack.loft.sh/
8+
You can join the community and reachout to us regarding any queries and disscussion on the community slack channel at https://slack.loft.sh/

Diff for: docs/pages/index.mdx

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: vCluster Documentation
3+
slug: /
4+
hide_table_of_contents: true
5+
---
6+
7+
import { Redirect } from "@docusaurus/router";
8+
9+
export default function Home() {
10+
return <Redirect to="what-are-virtual-clusters" />;
11+
}

Diff for: docs/pages/networking/integrated_coredns.mdx

-51
This file was deleted.

Diff for: docs/pages/security/admission-control.mdx

-67
This file was deleted.

0 commit comments

Comments
 (0)