Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Commit

Permalink
remove docs, point to new locations
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Holbach <[email protected]>
  • Loading branch information
Daniel Holbach committed Jun 17, 2021
1 parent d551529 commit 0353630
Show file tree
Hide file tree
Showing 52 changed files with 23 additions and 4,468 deletions.
48 changes: 0 additions & 48 deletions .github/workflows/docs.yaml

This file was deleted.

3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,3 @@ docker/fluxy-dumbconf.priv
test/profiles
test/bin/
test/e2e/bats

# Docs
site/
19 changes: 0 additions & 19 deletions .readthedocs.yml

This file was deleted.

8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ the `blocked-needs-validation` label is removed, and the issue can be worked
on.

To set up Flux to test things, there's documentation about setting up a
[standalone install](docs/tutorials/get-started.md) and a [Helm
install](docs/tutorials/get-started-helm.md), which might be helpful.
[standalone install](https://fluxcd.io/legacy/flux/tutorials/get-started/) and a [Helm
install](https://fluxcd.io/legacy/flux/tutorials/get-started-helm/), which might be helpful.

Please talk to us on Slack, if you should get stuck anywhere. We appreciate
any help and look forward to talking to you soon!
Expand Down Expand Up @@ -79,10 +79,10 @@ This is a rough outline of how to prepare a contribution:

### How to build and run the project

Refer to the [building doc](docs/contributing/building.md) to find out how to build from
Refer to the [building doc](https://fluxcd.io/legacy/flux/contributing/building/) to find out how to build from
source.

Refer to the [Get Started Developing](docs/contributing/get-started-developing.md) guide for a walkthrough on developing Flux locally.
Refer to the [Get Started Developing](https://fluxcd.io/legacy/flux/contributing/get-started-developing/) guide for a walkthrough on developing Flux locally.

### How to run the test suite

Expand Down
6 changes: 0 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -189,9 +189,3 @@ build-fluxctl: release-bins
--build-arg VCS_REF="$(VCS_REF)" \
--build-arg BUILD_DATE="$(BUILD_DATE)" \
-f ./build/docker/fluxctl/Dockerfile ./build/docker/fluxctl

docs-deps:
pip3 install -r docs/requirements.txt

serve-docs: docs-deps
mkdocs serve
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ new infrastructure.

[![CircleCI](https://circleci.com/gh/fluxcd/flux.svg?style=svg)](https://circleci.com/gh/fluxcd/flux)
[![GoDoc](https://godoc.org/github.com/fluxcd/flux?status.svg)](https://godoc.org/github.com/fluxcd/flux)
[![Documentation](https://img.shields.io/badge/latest-documentation-informational)](https://docs.fluxcd.io/en/latest/)
[![Documentation](https://img.shields.io/badge/latest-documentation-informational)](https://fluxcd.io/legacy/flux/)

## What Flux does

Expand All @@ -74,10 +74,10 @@ could easily integrate.

With the following tutorials:

- [Get started with Flux](https://docs.fluxcd.io/en/latest/tutorials/get-started)
- [Get started with Flux using Helm](https://docs.fluxcd.io/en/latest/tutorials/get-started-helm)
- [Get started with Flux](https://fluxcd.io/legacy/flux/tutorials/get-started/)
- [Get started with Flux using Helm](https://fluxcd.io/legacy/flux/tutorials/get-started-helm/)

or just [browse through the documentation](https://docs.fluxcd.io).
or just [browse through the documentation](https://fluxcd.io/legacy/flux/).

Do you want to release your Helm charts in a declarative way?
Take a look at the [`fluxcd/helm-operator`](https://github.com/fluxcd/helm-operator).
Expand Down Expand Up @@ -109,7 +109,7 @@ To familiarise yourself with the project and how things work, you might
be interested in the following:

- [Our contributions guidelines](CONTRIBUTING.md)
- [Build documentation](https://docs.fluxcd.io/en/latest/contributing/building)
- [Build documentation](https://fluxcd.io/legacy/flux/contributing/building/)
- [Release documentation](internal/docs/releasing.md)

## <a name="help"></a>Getting Help
Expand All @@ -123,7 +123,7 @@ Reminder that Flux v1 is in maintenance mode. If you have any questions about Fl

If you have further questions about Flux or continuous delivery:

- Read [the Flux docs](https://docs.fluxcd.io).
- Read [the Flux docs](https://fluxcd.io/legacy/flux/).
- Invite yourself to the <a href="https://slack.cncf.io" target="_blank">CNCF community</a>
slack and ask a question on the [#flux](https://cloud-native.slack.com/messages/flux/)
channel.
Expand Down
8 changes: 4 additions & 4 deletions chart/flux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Kubernetes >= v1.11
## Installation

We put together a simple [Get Started
tutorial](https://docs.fluxcd.io/en/stable/tutorials/get-started-helm) which takes about 5-10 minutes to follow.
tutorial](https://fluxcd.io/legacy/flux/tutorials/get-started-helm/) which takes about 5-10 minutes to follow.
You will have a fully working Flux installation deploying workloads to your cluster.

## Installing Flux using Helm
Expand Down Expand Up @@ -106,7 +106,7 @@ helm repo add fluxcd https://charts.fluxcd.io

If you haven't supplied your own deploy key, Flux generates an SSH key and logs the public
key at startup. You can obtain the SSH public key by installing
[fluxctl](https://docs.fluxcd.io/en/stable/references/fluxctl) and running:
[fluxctl](https://fluxcd.io/legacy/flux/references/fluxctl/) and running:

```sh
fluxctl identity --k8s-fwd-ns flux
Expand Down Expand Up @@ -326,8 +326,8 @@ The following tables lists the configurable parameters of the Flux chart and the
| `prometheus.serviceMonitor.interval` | `` | Interval at which metrics should be scraped
| `prometheus.serviceMonitor.namespace` | `` | The namespace where the ServiceMonitor is deployed
| `prometheus.serviceMonitor.additionalLabels` | `{}` | Additional labels to add to the ServiceMonitor
| `syncGarbageCollection.enabled` | `false` | If enabled, fluxd will delete resources that it created, but are no longer present in git (see [garbage collection](../../docs/references/garbagecollection.md))
| `syncGarbageCollection.dry` | `false` | If enabled, fluxd won't delete any resources, but log the garbage collection output (see [garbage collection](../../docs/references/garbagecollection.md))
| `syncGarbageCollection.enabled` | `false` | If enabled, fluxd will delete resources that it created, but are no longer present in git (see [garbage collection](https://fluxcd.io/legacy/flux/references/garbagecollection/))
| `syncGarbageCollection.dry` | `false` | If enabled, fluxd won't delete any resources, but log the garbage collection output (see [garbage collection](https://fluxcd.io/legacy/flux/references/garbagecollection/))
| `manifestGeneration` | `false` | If enabled, fluxd will look for `.flux.yaml` and run Kustomize or other manifest generators
| `hostAliases` | `{}` | Additional hostAliases to add to the Flux pod(s). See <https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/>
| `dashboards.enabled` | `false` | If enabled, flux will create a configmap with a dashboard in json that's going to be picked up by grafana (see [sidecar.dashboards.enabled](https://github.com/helm/charts/tree/master/stable/grafana#configuration)). Also remember to set `prometheus.enabled=true` to expose the metrics.
Expand Down
2 changes: 1 addition & 1 deletion chart/flux/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Get the Git deploy key by either (a) running
kubectl -n {{ .Release.Namespace }} logs deployment/{{ .Release.Name }} | grep identity.pub | cut -d '"' -f2

or by (b) installing fluxctl through
https://docs.fluxcd.io/en/latest/references/fluxctl#installing-fluxctl
https://fluxcd.io/legacy/flux/references/fluxctl/#installing-fluxctl
and running:

fluxctl identity --k8s-fwd-ns {{ .Release.Namespace }}
Expand Down
2 changes: 1 addition & 1 deletion deploy/flux-deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ spec:
# file, which you will need to do if you host your own git
# repo rather than using github or the like. You'll also need to
# mount it into the container, below. See
# https://docs.fluxcd.io/en/latest/guides/use-private-git-host
# https://fluxcd.io/legacy/flux/guides/use-private-git-host/
# - name: ssh-config
# configMap:
# name: flux-ssh-config
Expand Down
22 changes: 0 additions & 22 deletions docs/_files/flux-icon.svg

This file was deleted.

Binary file removed docs/_files/[email protected]
Binary file not shown.
Loading

0 comments on commit 0353630

Please sign in to comment.