From 8091bce411836db3698b9e3e72c139249aec225a Mon Sep 17 00:00:00 2001 From: Lauri Date: Thu, 21 Sep 2023 09:07:27 +0200 Subject: [PATCH 1/3] Fixes backporting gap between 0.29 and 0.30 --- .../getting-started/releases-enterprise.mdx | 2 +- ...-started.mdx => gitops-run-get-started.mdx} | 2 +- .../{overview.mdx => gitops-run-overview.mdx} | 2 +- .../gitops-templates/quickstart-templates.mdx | 2 +- ...erence.mdx => gitopssets-api-reference.mdx} | 0 ...llation.mdx => gitopssets-installation.mdx} | 0 .../{intro.mdx => gitopssets-intro.mdx} | 10 +++++----- .../{releases.mdx => gitopssets-releases.mdx} | 0 ...uide.mdx => templating-from-generators.mdx} | 0 ...arted.mdx => pipelines-getting-started.mdx} | 0 .../pipelines/pipelines-intro.mdx | 2 +- ...e-templates.mdx => pipelines-templates.mdx} | 0 .../pipelines/promoting-applications.mdx | 2 +- .../version-0.29.0-sidebars.json | 18 +++++++++--------- 14 files changed, 20 insertions(+), 20 deletions(-) rename website/versioned_docs/version-0.29.0/gitops-run/{get-started.mdx => gitops-run-get-started.mdx} (99%) rename website/versioned_docs/version-0.29.0/gitops-run/{overview.mdx => gitops-run-overview.mdx} (99%) rename website/versioned_docs/version-0.29.0/gitopssets/{api-reference.mdx => gitopssets-api-reference.mdx} (100%) rename website/versioned_docs/version-0.29.0/gitopssets/{installation.mdx => gitopssets-installation.mdx} (100%) rename website/versioned_docs/version-0.29.0/gitopssets/{intro.mdx => gitopssets-intro.mdx} (63%) rename website/versioned_docs/version-0.29.0/gitopssets/{releases.mdx => gitopssets-releases.mdx} (100%) rename website/versioned_docs/version-0.29.0/gitopssets/{guide.mdx => templating-from-generators.mdx} (100%) rename website/versioned_docs/version-0.29.0/pipelines/{getting-started.mdx => pipelines-getting-started.mdx} (100%) rename website/versioned_docs/version-0.29.0/pipelines/{pipeline-templates.mdx => pipelines-templates.mdx} (100%) diff --git a/website/versioned_docs/version-0.29.0/enterprise/getting-started/releases-enterprise.mdx b/website/versioned_docs/version-0.29.0/enterprise/getting-started/releases-enterprise.mdx index e1c6b453aa..973dc39cd2 100644 --- a/website/versioned_docs/version-0.29.0/enterprise/getting-started/releases-enterprise.mdx +++ b/website/versioned_docs/version-0.29.0/enterprise/getting-started/releases-enterprise.mdx @@ -597,7 +597,7 @@ config - Weave GitOps default admin user can now “read” all objects. Why is this important? As users are trying out Weave GitOps they will most likely try it out with some of their favorite Cloud Native tools such as Crossplane, Tekton, Istio, etc. This enables them to see all of those resources and explore the full power of Weave GitOps. We still do not recommend this user for “production-use” cases, and customers should always be pushed towards implementing OIDC with scoped roles. #### Pipelines - adding Pipelines through Templates -- From the Pipelines view you can add new Pipelines in a way which leverages GitOpsTemplates, additionally - to help users configure these, we’ve provided [documentation](../../pipelines/pipeline-templates.mdx) which has some samples. +- From the Pipelines view you can add new Pipelines in a way which leverages GitOpsTemplates, additionally - to help users configure these, we’ve provided [documentation](../../pipelines/pipelines-templates.mdx) which has some samples. #### Support for multiple Flux instances on a single cluster - Support for running multiple flux instances in different namespaces on a single cluster for resource isolation. diff --git a/website/versioned_docs/version-0.29.0/gitops-run/get-started.mdx b/website/versioned_docs/version-0.29.0/gitops-run/gitops-run-get-started.mdx similarity index 99% rename from website/versioned_docs/version-0.29.0/gitops-run/get-started.mdx rename to website/versioned_docs/version-0.29.0/gitops-run/gitops-run-get-started.mdx index 1099016688..360ac8f1e5 100644 --- a/website/versioned_docs/version-0.29.0/gitops-run/get-started.mdx +++ b/website/versioned_docs/version-0.29.0/gitops-run/gitops-run-get-started.mdx @@ -1,5 +1,5 @@ --- -title: Tutorial +title: Getting Started hide_title: true --- diff --git a/website/versioned_docs/version-0.29.0/gitops-run/overview.mdx b/website/versioned_docs/version-0.29.0/gitops-run/gitops-run-overview.mdx similarity index 99% rename from website/versioned_docs/version-0.29.0/gitops-run/overview.mdx rename to website/versioned_docs/version-0.29.0/gitops-run/gitops-run-overview.mdx index e1e855d48e..814c337d4b 100644 --- a/website/versioned_docs/version-0.29.0/gitops-run/overview.mdx +++ b/website/versioned_docs/version-0.29.0/gitops-run/gitops-run-overview.mdx @@ -1,5 +1,5 @@ --- -title: Overview +title: GitOps Run Overview hide_title: true --- diff --git a/website/versioned_docs/version-0.29.0/gitops-templates/quickstart-templates.mdx b/website/versioned_docs/version-0.29.0/gitops-templates/quickstart-templates.mdx index cf787813d1..bf2b2360b8 100644 --- a/website/versioned_docs/version-0.29.0/gitops-templates/quickstart-templates.mdx +++ b/website/versioned_docs/version-0.29.0/gitops-templates/quickstart-templates.mdx @@ -67,7 +67,7 @@ templates are now available for use: ## Available Templates -The following [pipeline](../pipelines/pipeline-templates.mdx) templates have +The following [pipeline](../pipelines/pipelines-templates.mdx) templates have been made available on your Weave GitOps Enterprise instance: - `pipeline-view`: A template to create a sample pipeline to visualize a diff --git a/website/versioned_docs/version-0.29.0/gitopssets/api-reference.mdx b/website/versioned_docs/version-0.29.0/gitopssets/gitopssets-api-reference.mdx similarity index 100% rename from website/versioned_docs/version-0.29.0/gitopssets/api-reference.mdx rename to website/versioned_docs/version-0.29.0/gitopssets/gitopssets-api-reference.mdx diff --git a/website/versioned_docs/version-0.29.0/gitopssets/installation.mdx b/website/versioned_docs/version-0.29.0/gitopssets/gitopssets-installation.mdx similarity index 100% rename from website/versioned_docs/version-0.29.0/gitopssets/installation.mdx rename to website/versioned_docs/version-0.29.0/gitopssets/gitopssets-installation.mdx diff --git a/website/versioned_docs/version-0.29.0/gitopssets/intro.mdx b/website/versioned_docs/version-0.29.0/gitopssets/gitopssets-intro.mdx similarity index 63% rename from website/versioned_docs/version-0.29.0/gitopssets/intro.mdx rename to website/versioned_docs/version-0.29.0/gitopssets/gitopssets-intro.mdx index 6a89eac327..8629d925c8 100644 --- a/website/versioned_docs/version-0.29.0/gitopssets/intro.mdx +++ b/website/versioned_docs/version-0.29.0/gitopssets/gitopssets-intro.mdx @@ -28,11 +28,11 @@ GitOpsSets will create out of the single resource all the objects and Flux primi **The initial generators that are coming with the preview release are:** -- [List Generator](./guide.mdx#list-generator): The simplest generator. Provide a list of Key/Value pairs that you want to feed the template with. -- [Git Generator](./guide.mdx#gitrepository-generator): Enable to extract a set of files (environment-specific configurations) from a Flux GitRepository, and make the contents of these available to the templates, this would let you have config in *app-dev.json*, *app-staging.json* and *app-production.json* for example, and the contents of these would be available to the templates. -- [Matrix Generator](./guide.mdx#matrix-generator): Combine slices of generators into the desired compounded input. -- [Pull request Generator](./guide.mdx#pullrequests-generator): Automatically discover open pull requests within a repository to generate a new deployment. -- [API Client Generator](./guide.mdx#apiclient-generator): Poll an HTTP endpoint and parse the result as the generated values. +- [List Generator](./templating-from-generators.mdx#list-generator): The simplest generator. Provide a list of Key/Value pairs that you want to feed the template with. +- [Git Generator](./templating-from-generators.mdx#gitrepository-generator): Enable to extract a set of files (environment-specific configurations) from a Flux GitRepository, and make the contents of these available to the templates, this would let you have config in *app-dev.json*, *app-staging.json* and *app-production.json* for example, and the contents of these would be available to the templates. +- [Matrix Generator](./templating-from-generators.mdx#matrix-generator): Combine slices of generators into the desired compounded input. +- [Pull request Generator](./templating-from-generators.mdx#pullrequests-generator): Automatically discover open pull requests within a repository to generate a new deployment. +- [API Client Generator](./templating-from-generators.mdx#apiclient-generator): Poll an HTTP endpoint and parse the result as the generated values. ## Use cases diff --git a/website/versioned_docs/version-0.29.0/gitopssets/releases.mdx b/website/versioned_docs/version-0.29.0/gitopssets/gitopssets-releases.mdx similarity index 100% rename from website/versioned_docs/version-0.29.0/gitopssets/releases.mdx rename to website/versioned_docs/version-0.29.0/gitopssets/gitopssets-releases.mdx diff --git a/website/versioned_docs/version-0.29.0/gitopssets/guide.mdx b/website/versioned_docs/version-0.29.0/gitopssets/templating-from-generators.mdx similarity index 100% rename from website/versioned_docs/version-0.29.0/gitopssets/guide.mdx rename to website/versioned_docs/version-0.29.0/gitopssets/templating-from-generators.mdx diff --git a/website/versioned_docs/version-0.29.0/pipelines/getting-started.mdx b/website/versioned_docs/version-0.29.0/pipelines/pipelines-getting-started.mdx similarity index 100% rename from website/versioned_docs/version-0.29.0/pipelines/getting-started.mdx rename to website/versioned_docs/version-0.29.0/pipelines/pipelines-getting-started.mdx diff --git a/website/versioned_docs/version-0.29.0/pipelines/pipelines-intro.mdx b/website/versioned_docs/version-0.29.0/pipelines/pipelines-intro.mdx index 6b85626f1e..50aff5ed65 100644 --- a/website/versioned_docs/version-0.29.0/pipelines/pipelines-intro.mdx +++ b/website/versioned_docs/version-0.29.0/pipelines/pipelines-intro.mdx @@ -25,4 +25,4 @@ The Pipelines feature: • streamlines code deployment from one environment to another, and minimizes friction between application development and Ops teams • enables you to easily define which Helm charts are part of the environments you create—saving lots of time through automated package management -Now that you know what delivery pipelines can do for you, follow the [guide to get started](../getting-started). \ No newline at end of file +Now that you know what delivery pipelines can do for you, follow the [guide to get started](../pipelines-getting-started). \ No newline at end of file diff --git a/website/versioned_docs/version-0.29.0/pipelines/pipeline-templates.mdx b/website/versioned_docs/version-0.29.0/pipelines/pipelines-templates.mdx similarity index 100% rename from website/versioned_docs/version-0.29.0/pipelines/pipeline-templates.mdx rename to website/versioned_docs/version-0.29.0/pipelines/pipelines-templates.mdx diff --git a/website/versioned_docs/version-0.29.0/pipelines/promoting-applications.mdx b/website/versioned_docs/version-0.29.0/pipelines/promoting-applications.mdx index 38cd197077..035260ba14 100644 --- a/website/versioned_docs/version-0.29.0/pipelines/promoting-applications.mdx +++ b/website/versioned_docs/version-0.29.0/pipelines/promoting-applications.mdx @@ -31,7 +31,7 @@ At the moment only applications defined as Flux `HelmReleases` are supported in
An example of a pull request for an application promotion
-The [Getting started guide](../getting-started) describes how to create a basic pipeline for an application so you can visualize its deployments across a series of environments. You may also configure a pipeline in order to promote applications across a series of environments. +The [Getting started guide](../pipelines-getting-started) describes how to create a basic pipeline for an application so you can visualize its deployments across a series of environments. You may also configure a pipeline in order to promote applications across a series of environments. There are currently two supported strategies for application promotions: - Pull request strategy: this strategy is used for applications that are delivered via Flux to all environments of a pipeline. Typically, the versions of these applications are stored in Git and therefore pull requests can be used to update them as part of a promotion. - Notification strategy: this strategy is used when an external CI system is responsible for promoting an application across the environments of a pipeline. In this strategy, the notification controller running on the management cluster is used to forward notifications of succesful promotions to external CI systems. diff --git a/website/versioned_sidebars/version-0.29.0-sidebars.json b/website/versioned_sidebars/version-0.29.0-sidebars.json index 2f9dc99630..cfd0bac9f5 100644 --- a/website/versioned_sidebars/version-0.29.0-sidebars.json +++ b/website/versioned_sidebars/version-0.29.0-sidebars.json @@ -103,21 +103,21 @@ "label": "GitOps Run", "link": { "type": "doc", - "id": "gitops-run/overview" + "id": "gitops-run/gitops-run-overview" }, "items": [ - "gitops-run/get-started" + "gitops-run/gitops-run-get-started" ] }, { "type": "category", "label": "GitOpsSets", "items": [ - "gitopssets/intro", - "gitopssets/installation", - "gitopssets/guide", - "gitopssets/api-reference", - "gitopssets/releases" + "gitopssets/gitopssets-intro", + "gitopssets/gitopssets-installation", + "gitopssets/gitopssets-guide", + "gitopssets/gitopssets-api-reference", + "gitopssets/gitopssets-releases" ] }, { @@ -138,10 +138,10 @@ "id": "pipelines/pipelines-intro" }, "items": [ - "pipelines/getting-started", + "pipelines/pipelines-getting-started", "pipelines/authorization", "pipelines/promoting-applications", - "pipelines/pipeline-templates", + "pipelines/pipelines-templates", "pipelines/pipelines-with-jenkins", "pipelines/pipelines-with-tekton", { From 7f40d17ed584a0dbea842d65742726374f2b2575 Mon Sep 17 00:00:00 2001 From: Lauri Date: Thu, 21 Sep 2023 09:21:23 +0200 Subject: [PATCH 2/3] fixes sidebar item --- website/versioned_sidebars/version-0.29.0-sidebars.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/versioned_sidebars/version-0.29.0-sidebars.json b/website/versioned_sidebars/version-0.29.0-sidebars.json index cfd0bac9f5..7a011cf806 100644 --- a/website/versioned_sidebars/version-0.29.0-sidebars.json +++ b/website/versioned_sidebars/version-0.29.0-sidebars.json @@ -115,7 +115,7 @@ "items": [ "gitopssets/gitopssets-intro", "gitopssets/gitopssets-installation", - "gitopssets/gitopssets-guide", + "gitopssets/gitopssets-templating-from-generators", "gitopssets/gitopssets-api-reference", "gitopssets/gitopssets-releases" ] From 305e1c8d0839eb2e7f644f8c5d1cee18824ddd7a Mon Sep 17 00:00:00 2001 From: Lauri Date: Thu, 21 Sep 2023 09:26:29 +0200 Subject: [PATCH 3/3] Fix round two --- website/versioned_sidebars/version-0.29.0-sidebars.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/versioned_sidebars/version-0.29.0-sidebars.json b/website/versioned_sidebars/version-0.29.0-sidebars.json index 7a011cf806..9f9f274ae0 100644 --- a/website/versioned_sidebars/version-0.29.0-sidebars.json +++ b/website/versioned_sidebars/version-0.29.0-sidebars.json @@ -115,7 +115,7 @@ "items": [ "gitopssets/gitopssets-intro", "gitopssets/gitopssets-installation", - "gitopssets/gitopssets-templating-from-generators", + "gitopssets/templating-from-generators", "gitopssets/gitopssets-api-reference", "gitopssets/gitopssets-releases" ]