diff --git a/website/docs/getting-started/deploy.mdx b/website/docs/getting-started/deploy.mdx new file mode 100644 index 0000000000..fee29cf153 --- /dev/null +++ b/website/docs/getting-started/deploy.mdx @@ -0,0 +1,142 @@ +--- +title: 2. Deploy an Application +hide_title: true +--- + +# Part 2: Deploy an Application + +Now that you have a feel for how to navigate the dashboard, let's deploy a new +application to explore further. In this section we will use the [podinfo](https://github.com/stefanprodan/podinfo) sample web application. + +## Deploying podinfo + +1. Clone or navigate back to your git repository where you have bootstrapped Flux, for example: + + ``` + git clone https://github.com/$GITHUB_USER/fleet-infra + cd fleet-infra + ``` + +1. Create a `GitRepository` Source for podinfo + + ``` + flux create source git podinfo \ + --url=https://github.com/stefanprodan/podinfo \ + --branch=master \ + --interval=30s \ + --export > ./clusters/my-cluster/podinfo-source.yaml + ``` + +1. Commit and push the `podinfo-source` to the `fleet-infra` repository + + ``` + git add -A && git commit -m "Add podinfo source" + git push + ``` + +1. Create a `kustomization` to build and apply the podinfo manifest + + ``` + flux create kustomization podinfo \ + --target-namespace=flux-system \ + --source=podinfo \ + --path="./kustomize" \ + --prune=true \ + --interval=5m \ + --export > ./clusters/my-cluster/podinfo-kustomization.yaml + ``` + +1. Commit and push the `podinfo-kustomization` to the `fleet-infra` repository + + ``` + git add -A && git commit -m "Add podinfo kustomization" + git push + ``` + +## View the application in Weave GitOps + +Flux will detect the updated `fleet-infra` and add podinfo. If we navigate back to the [dashboard](http://localhost:9001/) you should see the podinfo application appear. + +![Applications summary view showing Flux System, Weave GitOps and Podinfo](/img/dashboard-applications-with-podinfo.png) + +Click on podinfo and you will see details about the deployment, including that there are 2 pods available. + +![Applications details view for podinfo showing 2 pods](/img/dashboard-podinfo-details.png) + +:::info +Podinfo will come with the HorizontalPodAutoscaler, which uses the `metrics-server`. +For the purposes of this tutorial, we don't need the `metrics-server`, but it will mean +that the HorizontalPodAutoscaler will report as `Not ready` in your Dashboard. + +To remove this warning, install the [`metrics-server`](https://github.com/kubernetes-sigs/metrics-server) +(if you are using a `kind` cluster you may need to do more to get this working), +but you can ingore the warning if you prefer. +::: + +## Customize podinfo + +To customize a deployment from a repository you don’t control, you can use Flux in-line patches. The following example shows how to use in-line patches to change the podinfo deployment. + +1. Add the `patches` section as shown below to the field spec of your `podinfo-kustomization.yaml` file so it looks like this: + + ```yaml title="./clusters/my-cluster/podinfo-kustomization.yaml" + --- + apiVersion: kustomize.toolkit.fluxcd.io/v1beta2 + kind: Kustomization + metadata: + name: podinfo + namespace: flux-system + spec: + interval: 60m0s + path: ./kustomize + prune: true + sourceRef: + kind: GitRepository + name: podinfo + targetNamespace: flux-system + // highlight-start + patches: + - patch: |- + apiVersion: autoscaling/v2beta2 + kind: HorizontalPodAutoscaler + metadata: + name: podinfo + spec: + minReplicas: 3 + target: + name: podinfo + kind: HorizontalPodAutoscaler + // highlight-end + ``` + +1. Commit and push the `podinfo-kustomization.yaml` changes: + + ``` + git add -A && git commit -m "Increase podinfo minimum replicas" + git push + ``` + +3. Navigate back to the dashboard and you will now see a newly created pod + + ![Applications details view for podinfo showing 3 pods](/img/dashboard-podinfo-updated.png) + + +## Suspend updates + +Suspending updates to a kustomization allows you to directly edit objects applied from a kustomization, without your changes being reverted by the state in Git. + +To suspend updates for a kustomization, from the details page, click on the suspend button at the top, and you should see it be suspended: + +![Podinfo details showing Podinfo suspended](/img/dashboard-podinfo-details-suspended.png) + +This shows in the applications view with a yellow warning status indicating it is now suspended + +![Applications summary view showing Podinfo suspended](/img/dashboard-podinfo-suspended.png) + +To resume updates, go back to the details page, click the resume button, and after a few seconds reconsolidation will continue. + +## Complete! + +Congratulations πŸŽ‰πŸŽ‰πŸŽ‰ + +You've now completed the getting started guide. We would welcome any and all [feedback](/feedback-and-telemetry) on your experience. diff --git a/website/docs/getting-started/intro.mdx b/website/docs/getting-started/intro.mdx new file mode 100644 index 0000000000..4dc27c8d3a --- /dev/null +++ b/website/docs/getting-started/intro.mdx @@ -0,0 +1,16 @@ +--- +title: Getting Started +hide_title: true +--- + +# Getting Started with Weave GitOps + +This hands-on guide will introduce you to the basics of the GitOps Dashboard web UI, to help you understand the state of your system, before deploying a new application to your cluster. It is adapted from this guide - [Flux - Getting Started](https://fluxcd.io/docs/get-started/). + +If you haven't already, be sure to check out our [introduction](../intro.mdx) to Weave GitOps and our [installation docs](../installation/index.mdx). + +## TL;DR: Highlights + +- **Applications view** - allows you to quickly understand the state of your deployments across a cluster at a glance. It shows summary information from `kustomization` and `helmrelease` objects. +- **Sources view** - shows the status of resources which are synchronizing content from where you have declared the desired state of your system, for example Git repositories. This shows summary information from `gitrepository`, `helmrepository` and `bucket` objects. +- **Flux Runtime view** - provides status on the GitOps engine continuously reconciling your desired and live state. It shows your installed GitOps Toolkit Controllers and their version. diff --git a/website/docs/getting-started.mdx b/website/docs/getting-started/ui.mdx similarity index 51% rename from website/docs/getting-started.mdx rename to website/docs/getting-started/ui.mdx index 1bc096ed08..089cda396f 100644 --- a/website/docs/getting-started.mdx +++ b/website/docs/getting-started/ui.mdx @@ -1,25 +1,13 @@ --- -title: Getting Started +title: 1. Explore the GitOps UI hide_title: true --- -# Getting Started with Weave GitOps - -This hands-on guide will introduce you to the basics of the GitOps Dashboard web UI, to help you understand the state of your system, before deploying a new application to your cluster. It is adapted from this guide - [Flux - Getting Started](https://fluxcd.io/docs/get-started/). - -If you haven't already, be sure to check out our [introduction](./intro.mdx) to Weave GitOps and our [installation docs](./installation/index.mdx). - -## TL;DR: Highlights - -- **Applications view** - allows you to quickly understand the state of your deployments across a cluster at a glance. It shows summary information from `kustomization` and `helmrelease` objects. -- **Sources view** - shows the status of resources which are synchronizing content from where you have declared the desired state of your system, for example Git repositories. This shows summary information from `gitrepository`, `helmrepository` and `bucket` objects. -- **Flux Runtime view** - provides status on the GitOps engine continuously reconciling your desired and live state. It shows your installed GitOps Toolkit Controllers and their version. - -## Part 1 - Weave GitOps overview +# Part 1: Explore the GitOps UI Weave GitOps provides insights into your application deployments, and makes continuous delivery with GitOps easier to adopt and scale across your teams. We will now login to the dashboard web UI and start to explore the state of our GitOps deployments. -### Login to the GitOps Dashboard +## Login to the GitOps Dashboard 1. Expose the service running on the cluster @@ -27,11 +15,11 @@ Weave GitOps provides insights into your application deployments, and makes cont kubectl port-forward svc/ww-gitops-weave-gitops -n flux-system 9001:9001 ``` -1. [Open the dashboard](http://localhost:9001/) and login using either the cluster user or OIDC based on your [configuration](./configuration/securing-access-to-the-dashboard.mdx). If you followed the example above, the username will be `admin`, and the password is the non-encrypted value you provided as $PASSWORD. +1. [Open the dashboard](http://localhost:9001/) and login using either the cluster user or OIDC based on your [configuration](../configuration/securing-access-to-the-dashboard.mdx). If you followed the example above, the username will be `admin`, and the password is the non-encrypted value you provided as $PASSWORD. ![Weave GitOps login screen](/img/dashboard-login.png) -### Applications view +## Applications view When you login to the dashboard you are brought to the Applications view, which allows you to quickly understand the state of your deployments across a cluster at a glance. It shows summary information from `kustomization` and `helmrelease` objects. @@ -47,7 +35,7 @@ You can search for and filter objects by `Name` by clicking the magnifying glass Clicking the Name of an object will take you to a detailed view for the given Kustomization or HelmRelease. Which we will explore in a moment. -### The Sources view +## The Sources view Clicking on Sources in the left hand menu will bring you to the Sources view. This view shows you where flux pulls its application definitions from, for example Git repositories, and the current state of that synchronization. This shows summary information from `gitrepository`, `helmrepository`, `helmchart` and `bucket` objects. @@ -60,12 +48,11 @@ In the above screenshot you can see: The table view again shows summary status information so you can see whether Flux has been able to successfully pull from a given source and which specific commit was last detected. It shows key information like the `Interval`, namely how frequently Flux will check for updates in a given source location. You can apply filtering as per the Applications view, can click the `URL` to navigate to a given source i.e. a repository in GitHub, or the `Name` of a `Source` to view more details about it. - -### The Flux Runtime view +## The Flux Runtime view Clicking on `Flux Runtime` provides information on the GitOps engine, which is continuously reconciling your desired and live state. It provides two different tabs: controllers and CRDs. -#### Controllers +### Controllers The controllers tab shows your installed GitOps Toolkit Controllers and their version. @@ -81,7 +68,7 @@ For a full description of the controllers, see [GitOps ToolKit components](https From this view you can see whether the controllers are healthy and which version of a given component is currently deployed. -#### CRDs +### CRDs The CRD tab lists the custom resources that the GitOps Toolkit Controllers use. This helps you see what resources you will be able to create. @@ -93,7 +80,7 @@ Let's explore the `flux-system` kustomization. Navigate back to the `Application ![Application detail view for the flux system kustomization](/img/dashboard-application-flux.png) -After a few moments loading the data, you should see similar to the above screenshot. From here you can see key information about how this resource is defined: which `Source` it is reading from, the latest applied commit, the exact path with the Source repository that is being deployed, and the `Interval` in which Flux will look to reconcile any difference between the declared and live state - i.e. if a kubectl patch had been applied on the cluster, it would effectively be reverted. If a longer error message was being reported by this object, you would be able to see it in its entirety on this page. +After a few moments loading the data, you should see similar to the above screenshot. From here you can see key information about how this resource is defined: which `Source` it is reading from, the latest applied commit, the exact path with the Source repository that is being deployed, and the `Interval` in which Flux will look to reconcile any difference between the declared and live state - i.e. if a `kubectl` patch had been applied on the cluster, it would effectively be reverted. If a longer error message was being reported by this object, you would be able to see it in its entirety on this page. Underneath the summary information are four tabs: @@ -112,139 +99,11 @@ Underneath the summary information are four tabs: **Yaml tab** ![Application detail view showing the yaml display](/img/dashboard-application-yaml.png) -#### Source details view -Finally lets look at the Source in more detail - go back to the Details tab, and click `GitRepository/flux-system` from the summary at the top of the page. +### Source details view +Finally let's look at the Source in more detail - go back to the Details tab, and click `GitRepository/flux-system` from the summary at the top of the page. ![Source detail view showing details for an object](/img/dashboard-source-flux.png) -As with an Application detail view, you can see key information about how the resource is defined. Then beneath alongside the Events tab, is a Related Automations view. This shows all the `kustomization` objects which have this object as their Source. - - -## Part 2 - Deploying and viewing podinfo application - -Now that you have a feel for how to navigate the dashboard. Let's deploy a new application and explore that as well. In this section we will use the [podinfo](https://github.com/stefanprodan/podinfo) sample web application. - -### Deploying podinfo - -1. Clone or navigate back to your git repository where you have bootstrapped Flux, for example: - - ``` - git clone https://github.com/$GITHUB_USER/fleet-infra - cd fleet-infra - ``` - -1. Create a `GitRepository` Source for podinfo - - ``` - flux create source git podinfo \ - --url=https://github.com/stefanprodan/podinfo \ - --branch=master \ - --interval=30s \ - --export > ./clusters/my-cluster/podinfo-source.yaml - ``` - -1. Commit and push the `podinfo-source` to the `fleet-infra` repository - - ``` - git add -A && git commit -m "Add podinfo source" - git push - ``` - -1. Create a `kustomization` to build and apply the podinfo manifest - - ``` - flux create kustomization podinfo \ - --target-namespace=flux-system \ - --source=podinfo \ - --path="./kustomize" \ - --prune=true \ - --interval=5m \ - --export > ./clusters/my-cluster/podinfo-kustomization.yaml - ``` - -1. Commit and push the `podinfo-kustomization` to the `fleet-infra` repository - - ``` - git add -A && git commit -m "Add podinfo kustomization" - git push - ``` - -### View the application in Weave GitOps - -Flux will detect the updated `fleet-infra` and add podinfo. If we navigate back to the [dashboard](http://localhost:9001/) you should see the podinfo application appear. - -![Applications summary view showing Flux System, Weave GitOps and Podinfo](/img/dashboard-applications-with-podinfo.png) - -Click on podinfo and you will see details about the deployment, including that there is 1 pod available. - -![Applications details view for podinfo showing 1 pods](/img/dashboard-podinfo-details.png) - -### Customize podinfo - -To customize a deployment from a repository you don’t control, you can use Flux in-line patches. The following example shows how to use in-line patches to change the podinfo deployment. - -1. Add the `patches` section as shown below to the field spec of your podinfo-kustomization.yaml file so it looks like this: - - ```yaml title="./clusters/my-cluster/podinfo-kustomization.yaml" - --- - apiVersion: kustomize.toolkit.fluxcd.io/v1beta2 - kind: Kustomization - metadata: - name: podinfo - namespace: flux-system - spec: - interval: 60m0s - path: ./kustomize - prune: true - sourceRef: - kind: GitRepository - name: podinfo - targetNamespace: flux-system - // highlight-start - patches: - - patch: |- - apiVersion: autoscaling/v2beta2 - kind: HorizontalPodAutoscaler - metadata: - name: podinfo - spec: - minReplicas: 3 - target: - name: podinfo - kind: HorizontalPodAutoscaler - // highlight-end - ``` - -1. Commit and push the podinfo-kustomization.yaml changes: - - ``` - git add -A && git commit -m "Increase podinfo minimum replicas" - git push - ``` - -3. Navigate back to the dashboard and you will now see 2 newly created pods - - ![Applications details view for podinfo showing 3 pods](/img/dashboard-podinfo-updated.png) - - -### Suspend updates - -Suspending updates to a kustomization allows you to directly edit objects applied from a kustomization, without your changes being reverted by the state in Git. - -To suspend updates for a kustomization, from the details page, click on the suspend button at the top, and you should see it be suspended: - -![Podinfo details showing Podinfo suspended](/img/dashboard-podinfo-details-suspended.png) - -This shows in the applications view with a yellow warning status indicating it is now suspended - -![Applications summary view showing Podinfo suspended](/img/dashboard-podinfo-suspended.png) - -To resume updates, go back to the details page, click the resume button, and after a few seconds reconsolidation will continue: - -![Applications details view for podinfo being resumed](/img/dashboard-podinfo-updated.png) - -## Complete! - -Congratulations πŸŽ‰πŸŽ‰πŸŽ‰ +As with an Application detail view, you can see key information about how the resource is defined. -You've now completed the getting started guide. We would welcome any and all [feedback](/feedback-and-telemetry) on your experience. +Now we are familiar with the Dashboard, let's deploy a new application :sparkles:. diff --git a/website/docs/gitops-run/get-started.mdx b/website/docs/gitops-run/get-started.mdx index 1bf81b3057..b088d3ff09 100644 --- a/website/docs/gitops-run/get-started.mdx +++ b/website/docs/gitops-run/get-started.mdx @@ -112,7 +112,7 @@ gitops beta run ./podinfo --no-session --port-forward namespace=dev,resource=svc ``` You will now be asked if you want to install Flux and the GitOps -[dashboard](../getting-started.mdx). Answer yes and set a password, and +[dashboard](../getting-started/intro.mdx). Answer yes and set a password, and shortly after you should be able to [open the dashboard](http://localhost:9001) to see what's in your cluster - including the resources that GitOps Run is operating. diff --git a/website/docs/guides/displaying-custom-metadata.mdx b/website/docs/guides/displaying-custom-metadata.mdx index 6a15a38bf9..ea0fb439d0 100644 --- a/website/docs/guides/displaying-custom-metadata.mdx +++ b/website/docs/guides/displaying-custom-metadata.mdx @@ -9,7 +9,7 @@ system or another external system, or documentation and comments that are visible straight in the main UI. We will use the podinfo application that we installed in the [getting -started guide](../getting-started.mdx) as an example. Open up the +started guide](../getting-started/intro.mdx) as an example. Open up the podinfo kustomization and add annotations to it so it looks like this: ```yaml title="./clusters/my-cluster/podinfo-kustomization.yaml" diff --git a/website/docs/installation/aws-marketplace.mdx b/website/docs/installation/aws-marketplace.mdx index d177caf8cc..43bb2f69bb 100644 --- a/website/docs/installation/aws-marketplace.mdx +++ b/website/docs/installation/aws-marketplace.mdx @@ -1,7 +1,7 @@ --- title: AWS Marketplace hide_title: true -pagination_next: "getting-started" +pagination_next: getting-started/ui --- ## AWS Marketplace @@ -181,4 +181,4 @@ Your Weave GitOps installation is now ready! ## Next steps -In our following [Get Started document](../getting-started.mdx), we will walk you through logging into the GitOps Dashboard and deploying an application. +In our following [Get Started document](../getting-started/ui.mdx), we will walk you through logging into the GitOps Dashboard and deploying an application. diff --git a/website/docs/installation/index.mdx b/website/docs/installation/index.mdx index b8cf2d6116..9f8355d634 100644 --- a/website/docs/installation/index.mdx +++ b/website/docs/installation/index.mdx @@ -3,11 +3,9 @@ title: Installation hide_title: true --- -## Installing Weave GitOps +# Part 0: Installing Weave GitOps -### Pre-requisites - -#### Kubernetes Cluster +## Check your Cluster's Kubernetes Version No matter which version of Weave GitOps you install, having a Kubernetes cluster up and running is required. This version of Weave GitOps is tested against the following @@ -22,13 +20,13 @@ and running is required. This version of Weave GitOps is tested against the foll Note that the version of [Flux](https://fluxcd.io/docs/installation/#prerequisites) that you use might impose further minimum version requirements. -### Installing Weave GitOps itself +## Deploy Weave GitOps to your Cluster Depending on your setup and requirement you have the following choice | Installation | | ------------------------------------------------------ | -| [Weave GitOps](weave-gitops.mdx) | +| [Weave GitOps OSS](weave-gitops.mdx) | | [Weave GitOps Enterprise](weave-gitops-enterprise) | -| [Weave GitOps Enterprise - Airgap Environmnets](weave-gitops-enterprise/airgap) | +| [Weave GitOps Enterprise - Airgap Environments](weave-gitops-enterprise/airgap) | | [AWS Marketplace](aws-marketplace.mdx) | diff --git a/website/docs/installation/weave-gitops-enterprise/airgap.mdx b/website/docs/installation/weave-gitops-enterprise/airgap.mdx index 9ed40c443a..05a7d83069 100644 --- a/website/docs/installation/weave-gitops-enterprise/airgap.mdx +++ b/website/docs/installation/weave-gitops-enterprise/airgap.mdx @@ -2,7 +2,7 @@ title: Airgap Environments hide_title: true toc_max_heading_level: 4 -pagination_next: "getting-started" +pagination_next: getting-started/ui --- import TierLabel from "../../_components/TierLabel"; diff --git a/website/docs/installation/weave-gitops-enterprise/index.mdx b/website/docs/installation/weave-gitops-enterprise/index.mdx index ec4f0526dd..c5501c07ae 100644 --- a/website/docs/installation/weave-gitops-enterprise/index.mdx +++ b/website/docs/installation/weave-gitops-enterprise/index.mdx @@ -1,7 +1,7 @@ --- title: Weave GitOps Enterprise hide_title: true -pagination_next: "getting-started" +pagination_next: getting-started/ui --- import Tabs from "@theme/Tabs"; @@ -338,7 +338,7 @@ gitops version ## Next steps -In our following [Get Started document](../../getting-started.mdx), we will walk you through logging into the GitOps Dashboard and deploying an application. +In our following [Get Started document](../../getting-started/ui.mdx), we will walk you through logging into the GitOps Dashboard and deploying an application. Then you can head over to either: diff --git a/website/docs/installation/weave-gitops.mdx b/website/docs/installation/weave-gitops.mdx index 7ee38f95d1..907da13736 100644 --- a/website/docs/installation/weave-gitops.mdx +++ b/website/docs/installation/weave-gitops.mdx @@ -1,7 +1,7 @@ --- -title: Weave GitOps +title: Weave GitOps OSS hide_title: true -pagination_next: "getting-started" +pagination_next: getting-started/ui --- ## Installing Weave GitOps on your Cluster @@ -25,11 +25,11 @@ later has already been installed on your Kubernetes cluster. Full documentation is available [here][fl-install]. This version of Weave GitOps is tested against the following Flux releases: -* 0.32 -* 0.33 -* 0.34 -* 0.35 * 0.36 +* 0.35 +* 0.34 +* 0.33 +* 0.32 In this section we are going to do the following: @@ -38,6 +38,8 @@ In this section we are going to do the following: - Deploy Flux Components to your Kubernetes Cluster - Configure Flux components to track the path `./clusters/my-cluster/` in the repository +Let's get into it... :sparkles: + 1. Install the flux CLI ``` @@ -46,7 +48,7 @@ In this section we are going to do the following: For other installation methods, see the relevant [Flux documentation][fl-install]. -1. Export your credentials +1. Export your credentials (ensure your PAT has `repo` scope) ``` export GITHUB_TOKEN= @@ -66,7 +68,9 @@ In this section we are going to do the following: βœ” prerequisites checks passed ``` -1. Install Flux onto your cluster with the `flux bootstrap` command +1. Install Flux onto your cluster with the `flux bootstrap` command. The command + below assumes the Git provider to be `github`, alter this if you would rather use + `gitlab`. ``` flux bootstrap github \ @@ -160,7 +164,8 @@ In this section we will do the following: git push ``` -1. Validate that Weave GitOps and Flux are installed +1. Validate that Weave GitOps and Flux are installed. _Note: this wont be instantaneous, + give the Flux controllers a couple of minutes to pull the latest commit._ ``` kubectl get pods -n flux-system @@ -184,7 +189,7 @@ In this section we will do the following: ## Next steps -In the following [Get Started document](../getting-started.mdx), we will walk you +In the following [Get Started document](../getting-started/ui.mdx), we will walk you through logging into the GitOps Dashboard and deploying an application. [ee-install]: ../weave-gitops-enterprise diff --git a/website/docs/intro.mdx b/website/docs/intro.mdx index 4f928265e2..aa6f299cf0 100644 --- a/website/docs/intro.mdx +++ b/website/docs/intro.mdx @@ -19,7 +19,7 @@ and original creators of [Flux][flux]. ## Getting Started -To start your own journey with Weave GitOps, please see [Installation](./installation/index.mdx) and [Getting Started](./getting-started.mdx). +To start your own journey with Weave GitOps, please see [Installation](./installation/index.mdx) and [Getting Started](./getting-started/intro.mdx). Here is a quick demo of what you can look forward to: diff --git a/website/docs/references/helm-reference.md b/website/docs/references/helm-reference.md index 6c005e81e7..39b8faf3cd 100644 --- a/website/docs/references/helm-reference.md +++ b/website/docs/references/helm-reference.md @@ -7,7 +7,7 @@ title: Helm Chart Reference This is a reference of all the configurable values in weave gitops's helm chart. This is intended for customizing your installation after -you've gone through the [getting started](../getting-started.mdx) guide. +you've gone through the [getting started](../getting-started/intro.mdx) guide. This reference was generated for the chart version 4.0.13 which installs weave gitops v0.16.0. diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index f4b0ba75f0..33b0f89621 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -43,13 +43,7 @@ module.exports = { items: [ { type: "doc", - docId: "installation/index", - position: "left", - label: "Installation", - }, - { - type: "doc", - docId: "getting-started", + docId: "intro", position: "left", label: "Getting Started", }, diff --git a/website/sidebars.js b/website/sidebars.js index 83eb6fd36d..a5007d6109 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -11,31 +11,54 @@ module.exports = { docs: [ - 'intro', { type: 'category', - label: 'Installation', + label: 'Introducing GitOps', + collapsed: false, link: { type: 'doc', - id: 'installation/index', + id: 'intro', }, items: [ - 'installation/weave-gitops', { type: 'category', - label: 'Weave GitOps Enterprise', + label: 'Getting Started', + collapsed: false, link: { type: 'doc', - id: 'installation/weave-gitops-enterprise/index', + id: 'getting-started/intro', }, items: [ - 'installation/weave-gitops-enterprise/airgap', + { + type: 'category', + label: '0. Install Weave GitOps', + collapsed: true, + link: { + type: 'doc', + id: 'installation/index', + }, + items: [ + 'installation/weave-gitops', + { + type: 'category', + label: 'Weave GitOps Enterprise', + link: { + type: 'doc', + id: 'installation/weave-gitops-enterprise/index', + }, + items: [ + 'installation/weave-gitops-enterprise/airgap', + ], + }, + 'installation/aws-marketplace', + ], + }, + 'getting-started/ui', + 'getting-started/deploy', ], }, - 'installation/aws-marketplace', ], }, - 'getting-started', { type: 'category', label: 'Enterprise Edition',