From 20557f9f154df01e6ac62d8cde20eb8857ce5dcb Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 30 Aug 2022 14:50:05 +0200 Subject: [PATCH] update to new doc links structure Signed-off-by: Daniel Holbach --- CONTRIBUTING.md | 2 +- README.md | 50 +++++++++---------- docs/_redirects | 14 +++--- .../generic/secret-azure-credentials.yaml | 4 +- .../aws/config-patches.yaml | 4 +- rfcs/0002-helm-oci/README.md | 2 +- 6 files changed, 38 insertions(+), 38 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2886fd7..282b4c95 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,7 +59,7 @@ This project is composed of: ### Understanding the code To get started with developing controllers, you might want to review -[our guide](https://fluxcd.io/docs/gitops-toolkit/source-watcher/) which +[our guide](https://fluxcd.io/flux/gitops-toolkit/source-watcher/) which walks you through writing a short and concise controller that watches out for source changes. diff --git a/README.md b/README.md index b0a8b4b4..abed3040 100644 --- a/README.md +++ b/README.md @@ -24,14 +24,14 @@ Flux is a Cloud Native Computing Foundation ([CNCF](https://www.cncf.io/)) proje ## Quickstart and documentation -To get started check out this [guide](https://fluxcd.io/docs/get-started/) +To get started check out this [guide](https://fluxcd.io/flux/get-started/) on how to bootstrap Flux on Kubernetes and deploy a sample application in a GitOps manner. For more comprehensive documentation, see the following guides: -- [Ways of structuring your repositories](https://fluxcd.io/docs/guides/repository-structure/) -- [Manage Helm Releases](https://fluxcd.io/docs/guides/helmreleases/) -- [Automate image updates to Git](https://fluxcd.io/docs/guides/image-update/) -- [Manage Kubernetes secrets with Mozilla SOPS](https://fluxcd.io/docs/guides/mozilla-sops/) +- [Ways of structuring your repositories](https://fluxcd.io/flux/guides/repository-structure/) +- [Manage Helm Releases](https://fluxcd.io/flux/guides/helmreleases/) +- [Automate image updates to Git](https://fluxcd.io/flux/guides/image-update/) +- [Manage Kubernetes secrets with Mozilla SOPS](https://fluxcd.io/flux/guides/mozilla-sops/) If you need help, please refer to our **[Support page](https://fluxcd.io/support/)**. @@ -46,28 +46,28 @@ automation tooling. You can use the toolkit to extend Flux, or to build your own systems for continuous delivery -- see [the developer -guides](https://fluxcd.io/docs/gitops-toolkit/source-watcher/). +guides](https://fluxcd.io/flux/gitops-toolkit/source-watcher/). ### Components -- [Source Controller](https://fluxcd.io/docs/components/source/) - - [GitRepository CRD](https://fluxcd.io/docs/components/source/gitrepositories/) - - [OCIRepository CRD](https://fluxcd.io/docs/components/source/ocirepositories/) - - [HelmRepository CRD](https://fluxcd.io/docs/components/source/helmrepositories/) - - [HelmChart CRD](https://fluxcd.io/docs/components/source/helmcharts/) - - [Bucket CRD](https://fluxcd.io/docs/components/source/buckets/) -- [Kustomize Controller](https://fluxcd.io/docs/components/kustomize/) - - [Kustomization CRD](https://fluxcd.io/docs/components/kustomize/kustomization/) -- [Helm Controller](https://fluxcd.io/docs/components/helm/) - - [HelmRelease CRD](https://fluxcd.io/docs/components/helm/helmreleases/) -- [Notification Controller](https://fluxcd.io/docs/components/notification/) - - [Provider CRD](https://fluxcd.io/docs/components/notification/provider/) - - [Alert CRD](https://fluxcd.io/docs/components/notification/alert/) - - [Receiver CRD](https://fluxcd.io/docs/components/notification/receiver/) -- [Image Automation Controllers](https://fluxcd.io/docs/components/image/) - - [ImageRepository CRD](https://fluxcd.io/docs/components/image/imagerepositories/) - - [ImagePolicy CRD](https://fluxcd.io/docs/components/image/imagepolicies/) - - [ImageUpdateAutomation CRD](https://fluxcd.io/docs/components/image/imageupdateautomations/) +- [Source Controller](https://fluxcd.io/flux/components/source/) + - [GitRepository CRD](https://fluxcd.io/flux/components/source/gitrepositories/) + - [OCIRepository CRD](https://fluxcd.io/flux/components/source/ocirepositories/) + - [HelmRepository CRD](https://fluxcd.io/flux/components/source/helmrepositories/) + - [HelmChart CRD](https://fluxcd.io/flux/components/source/helmcharts/) + - [Bucket CRD](https://fluxcd.io/flux/components/source/buckets/) +- [Kustomize Controller](https://fluxcd.io/flux/components/kustomize/) + - [Kustomization CRD](https://fluxcd.io/flux/components/kustomize/kustomization/) +- [Helm Controller](https://fluxcd.io/flux/components/helm/) + - [HelmRelease CRD](https://fluxcd.io/flux/components/helm/helmreleases/) +- [Notification Controller](https://fluxcd.io/flux/components/notification/) + - [Provider CRD](https://fluxcd.io/flux/components/notification/provider/) + - [Alert CRD](https://fluxcd.io/flux/components/notification/alert/) + - [Receiver CRD](https://fluxcd.io/flux/components/notification/receiver/) +- [Image Automation Controllers](https://fluxcd.io/flux/components/image/) + - [ImageRepository CRD](https://fluxcd.io/flux/components/image/imagerepositories/) + - [ImagePolicy CRD](https://fluxcd.io/flux/components/image/imagepolicies/) + - [ImageUpdateAutomation CRD](https://fluxcd.io/flux/components/image/imageupdateautomations/) ## Community @@ -75,7 +75,7 @@ Need help or want to contribute? Please see the links below. The Flux project is new contributors and there are a multitude of ways to get involved. - Getting Started? - - Look at our [Get Started guide](https://fluxcd.io/docs/get-started/) and give us feedback + - Look at our [Get Started guide](https://fluxcd.io/flux/get-started/) and give us feedback - Need help? - First: Ask questions on our [GH Discussions page](https://github.com/fluxcd/flux2/discussions) - Second: Talk to us in the #flux channel on [CNCF Slack](https://slack.cncf.io/) diff --git a/docs/_redirects b/docs/_redirects index 4b23c408..4860a76c 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,18 +1,18 @@ # individual rules -/core-concepts https://fluxcd.io/docs/concepts 301! +/core-concepts https://fluxcd.io/flux/concepts 301! /contributing https://fluxcd.io/contributing 301! /install.sh https://fluxcd.io/install.sh 301! # refer to https://github.com/fluxcd/flux2/discussions/367 -/dev-guides/* https://fluxcd.io/docs/gitops-toolkit/:splat 301! +/dev-guides/* https://fluxcd.io/flux/gitops-toolkit/:splat 301! # this is how things looked in the navbar anyway..? -/guides/faq-migration https://fluxcd.io/docs/migration/faq-migration 301! -/guides/flux-v1-automation-migration https://fluxcd.io/docs/migration/flux-v1-automation-migration 301! -/guides/flux-v1-migration https://fluxcd.io/docs/migration/flux-v1-migration 301! -/guides/helm-operator-migration https://fluxcd.io/docs/migration/helm-operator-migration 301! +/guides/faq-migration https://fluxcd.io/flux/migration/faq-migration 301! +/guides/flux-v1-automation-migration https://fluxcd.io/flux/migration/flux-v1-automation-migration 301! +/guides/flux-v1-migration https://fluxcd.io/flux/migration/flux-v1-migration 301! +/guides/helm-operator-migration https://fluxcd.io/flux/migration/helm-operator-migration 301! # catch all -/* https://fluxcd.io/docs/:splat 301! +/* https://fluxcd.io/flux/:splat 301! diff --git a/manifests/integrations/eventhub-credentials-sync/_cronjobs/generic/secret-azure-credentials.yaml b/manifests/integrations/eventhub-credentials-sync/_cronjobs/generic/secret-azure-credentials.yaml index 8a6d8a2c..af2da5b3 100644 --- a/manifests/integrations/eventhub-credentials-sync/_cronjobs/generic/secret-azure-credentials.yaml +++ b/manifests/integrations/eventhub-credentials-sync/_cronjobs/generic/secret-azure-credentials.yaml @@ -10,5 +10,5 @@ metadata: type: Opaque # This is just a example secret, you should never store secrets in git. # One way forward can be to use sealed-secrets or SOPS -# https://fluxcd.io/docs/guides/sealed-secrets/ -# https://fluxcd.io/docs/guides/mozilla-sops/ +# https://fluxcd.io/flux/guides/sealed-secrets/ +# https://fluxcd.io/flux/guides/mozilla-sops/ diff --git a/manifests/integrations/registry-credentials-sync/aws/config-patches.yaml b/manifests/integrations/registry-credentials-sync/aws/config-patches.yaml index b99001a6..f57ccf79 100644 --- a/manifests/integrations/registry-credentials-sync/aws/config-patches.yaml +++ b/manifests/integrations/registry-credentials-sync/aws/config-patches.yaml @@ -24,8 +24,8 @@ metadata: ## If not using IRSA, set the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables ## Store these values in a Secret and load them in the container using envFrom. ## For managing this secret via GitOps, consider using SOPS or SealedSecrets and add that manifest in a resource file for this kustomize build. -## https://fluxcd.io/docs/guides/mozilla-sops/ -## https://fluxcd.io/docs/guides/sealed-secrets/ +## https://fluxcd.io/flux/guides/mozilla-sops/ +## https://fluxcd.io/flux/guides/sealed-secrets/ # --- # apiVersion: apps/v1 # kind: Deployment diff --git a/rfcs/0002-helm-oci/README.md b/rfcs/0002-helm-oci/README.md index a5413917..7c6c5b72 100644 --- a/rfcs/0002-helm-oci/README.md +++ b/rfcs/0002-helm-oci/README.md @@ -37,7 +37,7 @@ When the `spec.type` field is set to `oci`, the `spec.url` field must be prefixe For `oci://` URLs, source-controller will use the Helm SDK and the `oras` library to connect to the OCI remote storage. Introduce an optional field called `provider` for -[context-based authorization](https://fluxcd.io/docs/security/contextual-authorization/) +[context-based authorization](https://fluxcd.io/flux/security/contextual-authorization/) to AWS, Azure and Google Cloud. The `spec.provider` is ignored when `spec.type` is set to `default`.