Skip to content

Commit

Permalink
Added pro docs switch and links to pro docs
Browse files Browse the repository at this point in the history
Signed-off-by: Thomas Kosiewski <[email protected]>
  • Loading branch information
ThomasK33 committed Sep 16, 2023
1 parent b4ef578 commit c3e0712
Show file tree
Hide file tree
Showing 16 changed files with 280 additions and 522 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.{sh,yaml,yml,json}]
[*.{sh,yaml,yml,json,js,ts}]
indent_style = space
indent_size = 2

Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/e2e.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,11 @@ jobs:
go-version: "1.21"
cache: false

- uses: azure/setup-helm@v3
name: Setup Helm
with:
version: "v3.11.0"

- name: Set up kind k8s cluster
uses: engineerd/[email protected]
with:
Expand Down
6 changes: 6 additions & 0 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,9 @@ e2e distribution="k3s" path="./test/e2e" multinamespace="false": create-kind &&
cli version="0.0.0" *ARGS="":
RELEASE_VERSION={{ version }} go generate -tags embed_charts ./...
go run -tags embed_charts -mod vendor -ldflags "-X main.version={{ version }}" ./cmd/vclusterctl/main.go {{ ARGS }}

# --- Docs ---

# Version the docs for the given version
docs-version id="pro" version="1.0.0":
yarn docusaurus docs:version {{version}}
86 changes: 41 additions & 45 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,55 +1,55 @@
__webpack_public_path__ = "/docs/"
__webpack_public_path__ = "/docs/";

module.exports = {
title: 'vcluster docs | Virtual Clusters for Kubernetes',
tagline: 'Virtual Clusters for Kubernetes',
url: 'https://vcluster.com',
title: "vcluster docs | Virtual Clusters for Kubernetes",
tagline: "Virtual Clusters for Kubernetes",
url: "https://vcluster.com",
baseUrl: __webpack_public_path__,
favicon: '/media/vcluster_symbol.svg',
organizationName: 'loft-sh', // Usually your GitHub org/user name.
projectName: 'vcluster', // Usually your repo name.
favicon: "/media/vcluster_symbol.svg",
organizationName: "loft-sh", // Usually your GitHub org/user name.
projectName: "vcluster", // Usually your repo name.
themeConfig: {
colorMode: {
defaultMode: 'light',
defaultMode: "light",
disableSwitch: false,
respectPrefersColorScheme: true,
},
navbar: {
logo: {
alt: 'vcluster',
src: '/media/vCluster_horizontal-orange.svg',
href: 'https://vcluster.com/',
target: '_self',
alt: "vcluster",
src: "/media/vCluster_horizontal-orange.svg",
href: "https://vcluster.com/",
target: "_self",
},
items: [
{
href: 'https://vcluster.com/',
label: 'Website',
position: 'left',
target: '_self'
href: "https://vcluster.com/",
label: "Website",
position: "left",
target: "_self",
},
{
to: '/docs/what-are-virtual-clusters',
label: 'Docs',
position: 'left'
label: "Docs",
position: "left",
to: "/",
},
{
href: 'https://loft.sh/blog',
label: 'Blog',
position: 'left',
target: '_self'
href: "https://loft.sh/blog",
label: "Blog",
position: "left",
target: "_self",
},
{
href: 'https://slack.loft.sh/',
className: 'slack-link',
'aria-label': 'Slack',
position: 'right',
href: "https://slack.loft.sh/",
className: "slack-link",
"aria-label": "Slack",
position: "right",
},
{
href: 'https://github.com/loft-sh/vcluster',
className: 'github-link',
'aria-label': 'GitHub',
position: 'right',
href: "https://github.com/loft-sh/vcluster",
className: "github-link",
"aria-label": "GitHub",
position: "right",
},
],
},
Expand All @@ -58,41 +58,37 @@ module.exports = {
apiKey: "42375731adc726ebb99849e9051aa9b4",
indexName: "vcluster",
placeholder: "Search...",
algoliaOptions: {}
algoliaOptions: {},
},
footer: {
style: 'light',
style: "light",
links: [],
copyright: `Copyright © ${new Date().getFullYear()} <a href="https://loft.sh/">Loft Labs, Inc.</a>`,
},
},
presets: [
[
'@docusaurus/preset-classic',
"@docusaurus/preset-classic",
{
docs: {
path: 'pages',
routeBasePath: '/',
sidebarPath: require.resolve('./sidebars.js'),
editUrl:
'https://github.com/loft-sh/vcluster/edit/main/docs/',
path: "pages",
routeBasePath: "/",
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/loft-sh/vcluster/edit/main/docs/",
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
plugins: [],
scripts: [
{
src:
'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
src: "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
async: true,
},
{
src:
'/docs/js/custom.js',
src: "/docs/js/custom.js",
async: true,
},
],
Expand Down
76 changes: 0 additions & 76 deletions docs/pages/architecture/control_plane/isolated_control_planes.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/pages/community.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ sidebar_label: Community

### Slack

You can join the community and reachout to us regarding any queries and disscussion on the community slack channel at https://slack.loft.sh/
You can join the community and reachout to us regarding any queries and disscussion on the community slack channel at https://slack.loft.sh/
11 changes: 11 additions & 0 deletions docs/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: vCluster Documentation
slug: /
hide_table_of_contents: true
---

import { Redirect } from "@docusaurus/router";

export default function Home() {
return <Redirect to="what-are-virtual-clusters" />;
}
51 changes: 0 additions & 51 deletions docs/pages/networking/integrated_coredns.mdx

This file was deleted.

67 changes: 0 additions & 67 deletions docs/pages/security/admission-control.mdx

This file was deleted.

Loading

0 comments on commit c3e0712

Please sign in to comment.