diff --git a/docs/guided-tour/README.md b/docs/guided-tour/README.md index 2aca4393a..c99eae10d 100644 --- a/docs/guided-tour/README.md +++ b/docs/guided-tour/README.md @@ -1,6 +1,9 @@ -# Guided Tour +--- +title: Prerequisites +sidebar_position: 1 +--- -In this tour, you will learn about the different Landscaper features by simple examples. +# Guided Tour ## Prerequisites and Basic Definitions @@ -10,8 +13,7 @@ In this tour, you will learn about the different Landscaper features by simple e CLI](https://github.com/gardener/landscapercli). - During the following exercises, you might need to change files, provided with the examples. For this, you should - simply clone this repository and do the required changes on your local files. You could also fork the repo and work on - your fork. + simply clone [this repository](https://github.com/gardener/landscaper) and do the required changes on your local files. You could also fork the repo and work on your fork. - In all examples, 3 Kubernetes clusters are involved: @@ -23,56 +25,10 @@ In this tour, you will learn about the different Landscaper features by simple e It is possible that some or all of these clusters coincide, e.g. in the most simplistic approach, you have only one cluster. Such a "one-cluster-setup" is the easiest way to start working with the Landscaper. -> **_NOTE:_** **The Landscaper now also supports [OCM (Open Component Model)](https://ocm.software/) Component +> **_NOTE:_** The Landscaper now also supports [OCM (Open Component Model)](https://ocm.software/) Component > Descriptors [Version 3](https://ocm.software/docs/component-descriptors/version-3/), additionally to [Version > 2](https://ocm.software/docs/component-descriptors/version-2/). > Since we try our best to avoid disruptions, this functionality is currently behind a feature switch. For detailed > information on how to enable this for your own landscaper instance, set the corresponding flag in the configuration to > `true`, as shown [here](https://github.com/gardener/landscaper/blob/master/docs/installation/install-landscaper-controller.md#configuration-through-valuesyaml). -> If you just want to follow along the tour, you should have the switch enabled!** - -## A Hello World Example - -[1. Hello World Example](./hello-world) - -## Basics - -[2. Upgrading the Hello World Example](./basics/upgrade) - -[3. Manifest Deployer Example](./basics/manifest-deployer) - -[4. Multiple Deployments in One Installation](./basics/multiple-deployitems) - -## Recovering from Errors - -[5. Handling an Immediate Error](./error-handling/immediate-error) - -[6. Handling a Timeout Error](./error-handling/timeout-error) - -[7. Handling a Delete Error](./error-handling/delete-error) - -You can find a list of error messages and corresponding solutions [here](./error-handling/problem_analysis.md). - -## Blueprints and Components - -[8. An Installation with an Externally Stored Blueprint](./blueprints/external-blueprint) - -[9. Helm Chart Resources in the Component Descriptor](./blueprints/helm-chart-resource) - -[10. Echo Server Example](./blueprints/echo-server) - -## Imports and Exports - -[11. Import Parameters](./import-export/import-parameters) - -[12. Import Data Mappings](./import-export/import-data-mappings) - -[13. Export Parameters](./import-export/export-parameters) - -## Templating - -[14. Templating: Accessing Component Descriptors ](./templating/components) - -## Optimization - -[15. Optimization Hints ](../usage/Optimization.md) +> If you just want to follow along the tour, you should have the switch enabled! diff --git a/docs/guided-tour/hello-world/README.md b/docs/guided-tour/hello-world/README.md index 46f8ed145..71146a013 100644 --- a/docs/guided-tour/hello-world/README.md +++ b/docs/guided-tour/hello-world/README.md @@ -1,8 +1,13 @@ +--- +title: Hello World Example +sidebar_position: 2 +--- + # Hello World Example In this example, we use the Landscaper to deploy a simple Helm chart. -For prerequisites, see [here](https://github.com/gardener/landscaper/tree/master/docs/guided-tour#prerequisites-and-basic-definitions). +For prerequisites, see [here](../README.md). Our [hello-world Helm chart](https://github.com/gardener/landscaper/tree/master/docs/guided-tour/hello-world/chart/hello-world) is minimalistic on purpose, in order to concentrate on Landscaper rather than Helm features. Therefore, the chart only deploys a ConfigMap. We have uploaded the chart to a [public registry](https://eu.gcr.io/gardener-project/landscaper/examples/charts/hello-world:1.0.0) from where the Landscaper reads it during the deployment.