Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upstream/docs restructure #1169

Merged
merged 59 commits into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
41ff440
inital restructuring - partial arch. & networking
ishankhare07 Aug 4, 2023
4cf04c6
add ing traffix and network policies section
ishankhare07 Aug 7, 2023
3b3f6f4
deprecate networking section and finish syncer
ishankhare07 Aug 9, 2023
58d7d6a
Merge pull request #1140 from ishankhare07/deprecate-networking-finis…
ishankhare07 Aug 10, 2023
b89a5c3
Organise pages for Using vclusters section
neogopher Aug 8, 2023
ff9bdbe
Fix other markdown warnings
neogopher Aug 10, 2023
ec0c762
fix broken link for core resources
ishankhare07 Aug 10, 2023
c615222
Merge pull request #1138 from neogopher/docs-using-vclusters
ishankhare07 Aug 10, 2023
72af0ed
add observability section
ishankhare07 Aug 17, 2023
37d9bac
fix metrics to nodes links
ishankhare07 Aug 17, 2023
19c4754
Merge pull request #1162 from ishankhare07/docs-fix-metrics-nodes-links
ishankhare07 Aug 17, 2023
b7cf946
Organise pages for Deploying vclusters section
neogopher Aug 16, 2023
fefc805
Merge pull request #1160 from neogopher/docs-deploying-vclusters
ishankhare07 Aug 17, 2023
e2b5a9f
Organise pages for Advanced topics section
neogopher Aug 16, 2023
d297f68
Merge pull request #1161 from neogopher/docs-advanced-topics
ishankhare07 Aug 17, 2023
77c5024
Add Pro Docs
ishankhare07 Aug 17, 2023
d6142c1
initial page for help and trouble shooting
ishankhare07 Aug 21, 2023
87f323f
fix broken links failing builds
ishankhare07 Aug 21, 2023
71fc188
Organise pages for Security section
neogopher Aug 18, 2023
ecc1913
Merge pull request #1168 from loft-sh/docs/help-and-trouble
FabianKramm Aug 22, 2023
015ca1f
Merge pull request #1166 from neogopher/docs-security
FabianKramm Aug 22, 2023
96c6674
Merge pull request #1164 from ishankhare07/docs-add-pro-sections
ishankhare07 Aug 22, 2023
7137513
Remove quickstart section completely; Rename Full Guide to Quickstart
neogopher Aug 28, 2023
2e732d7
Indent out ns&host cluster subsection to NOT be under Components
neogopher Aug 28, 2023
4e16fee
Multinamespace mode page
neogopher Aug 28, 2023
4a09985
Rename the Sidebar title to Access
neogopher Aug 28, 2023
289422d
all sections but QuickStart should not be default expanded
neogopher Aug 28, 2023
b4b4a58
Remove older and migrated section pages
neogopher Aug 28, 2023
3fdbdb5
Merge pull request #1184 from neogopher/address-review-comments
alexandradragodan Aug 30, 2023
cfb0496
added pro label, fixed small typos, changed logo and multins diagram …
alexandradragodan Aug 30, 2023
7f9a96e
Merge pull request #1187 from loft-sh/docs-pro-label
neogopher Sep 4, 2023
1c84817
Add Pro features docs content
neogopher Sep 4, 2023
0dea016
change all 'vcluster' to 'vCluster'
neogopher Sep 4, 2023
16677cb
Fix broken links
neogopher Sep 4, 2023
ca437e3
Merge pull request #1190 from neogopher/docs-updates
neogopher Sep 12, 2023
5704412
Fix broken links
neogopher Sep 12, 2023
fd4a067
Merge pull request #1202 from neogopher/docs-fix-brokenlink-gh-actions
neogopher Sep 12, 2023
43dfd66
Fix more broken links
neogopher Sep 12, 2023
e657988
Merge pull request #1203 from neogopher/docs-fix-brokenlink-gh-actions
neogopher Sep 12, 2023
b4ef578
Merge branch 'main' into upstream/docs-restructure
Sep 14, 2023
c3e0712
Added pro docs switch and links to pro docs
Sep 16, 2023
e7a2fa9
Fixed sidebar docs link
Sep 16, 2023
6f6da71
Added pro icons
Sep 18, 2023
0e792b3
docs: add CLI docs generation
lizardruss Sep 20, 2023
ca0951d
docs: remove version from generate-cli-docs script
lizardruss Sep 21, 2023
a45d2e0
Merge pull request #1216 from loft-sh/cli-docs
ThomasK33 Sep 21, 2023
476df7e
docs: Rename 'vcluster --help' to 'CLI'
lizardruss Sep 26, 2023
c3bb9cb
docs: Add PRO commands to CLI docs
lizardruss Sep 26, 2023
36ae04b
fix remove space commands from pro CLI
lizardruss Sep 26, 2023
cb3bf95
docs: add banner to pro command pages
lizardruss Sep 27, 2023
db2e636
Merge pull request #1248 from loft-sh/ENG-2101
lizardruss Sep 29, 2023
0655da9
Merge branch 'main' into upstream/docs-restructure
pascalbreuninger Oct 3, 2023
fe30bf1
chore: vendor
pascalbreuninger Oct 3, 2023
90b9a9d
chore: regenerate cli docs
pascalbreuninger Oct 3, 2023
05cfbcd
chore: don\'t lint hack/docs/main.go
pascalbreuninger Oct 3, 2023
033784e
chore: remove old cli command docs
pascalbreuninger Oct 3, 2023
b7f0fab
added tutorials for provisioning with Helm, bootstrapping vclusters
alexandradragodan Oct 3, 2023
41bee01
fixed review comments
alexandradragodan Oct 3, 2023
066ea49
Merge pull request #1271 from loft-sh/help-and-tutorials
alexandradragodan Oct 3, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ -145,6 +145,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
10 changes: 10 additions & 0 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ copy-assets:
generate-vcluster-images version="0.0.0":
go run -mod vendor ./hack/assets/main.go {{ version }} > ./release/vcluster-images.txt

# Generate the CLI docs
generate-cli-docs:
go run -mod vendor -tags pro ./hack/docs/main.go

# Embed the charts into the vcluster binary
[private]
embed-charts version="0.0.0":
Expand Down Expand Up @@ -116,3 +120,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_MonoBranding.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
Loading
Loading