Skip to content

Commit a7cd1b8

Browse files
author
Daniel Holbach
committed
Move all Flux docs under /flux
New location for /docs/contributing is /contributing Fixes: #1107 Signed-off-by: Daniel Holbach <daniel@weave.works>
1 parent c626427 commit a7cd1b8

File tree

215 files changed

+277
-363
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

215 files changed

+277
-363
lines changed

β€Ž.gitignoreβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ themes/hugo-shortcode-gallery-*
1414
hugo/
1515

1616
# Imported Flux CLI assets
17-
content/en/docs/cmd/flux*
17+
content/en/flux/cmd/flux*
1818
static/install.sh
1919

2020
# Adopters logos

β€Ž.stignoreβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ _tmp
1212
public/
1313
# Output of "make theme"
1414
themes/
15-
!content/en/docs/components/*/_index.md
16-
content/en/docs/components/*/*.md
15+
!content/en/flux/components/*/_index.md
16+
content/en/flux/components/*/*.md
1717

1818
# Directory for instrumented libs generated by jscoverage/JSCover
1919
lib-cov

β€ŽREADME.mdβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This repo houses the assets used to build the Flux project's landing page at <ht
88
>
99
> Project | Docs Site | Github Source
1010
> ---------------- | ------------------------------------------| -------------
11-
> Flux | <https://fluxcd.io/docs> | <https://github.com/fluxcd/website>
11+
> Flux | <https://fluxcd.io/flux> | <https://github.com/fluxcd/website>
1212
> Flagger | <https://fluxcd.io/flagger> | <https://github.com/fluxcd/website>
1313
> Flux (legacy) | <https://fluxcd.io/legacy/flux> | <https://github.com/fluxcd/website>
1414
> Helm Operator | <https://fluxcd.io/legacy/helm-operator/> | <https://github.com/fluxcd/website>
@@ -17,11 +17,11 @@ This repo houses the assets used to build the Flux project's landing page at <ht
1717

1818
The main landing page of this website can be modified in `config.toml`.
1919

20-
Almost all of the content lives in the `content/en/docs` directory. Here are some special cases.
20+
Almost all of the content lives in the `content/en/<project>` directories. Here are some special cases.
2121

2222
- `./content/en/blog` contains all blog posts - make sure you update the front-matter for posts to show up correctly.
2323
- `./external-sources/` defines how files from other repositories are pulled in. We currently do this for Markdown files from the `/fluxcd/community` and `/fluxcd/.github` repositories. (`make gen-content` pulls these in.)
24-
- Flux CLI docs (`cmd`) and `components` docs: under `./content/en/docs` but pulled in through in `make gen-content` as well.
24+
- Flux CLI docs (`cmd`) and `components` docs: under `./content/en/flux` but pulled in through in `make gen-content` as well.
2525
- `/static/_redirects` defines redirects on <https://fluxcd.io>. Check out <https://docs.netlify.com/routing/redirects/> for the syntax definition and how to test if things work.
2626

2727
## Running the site locally

β€Žadopters/1-flux-v2.yamlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
adopters:
22
project: Flux
33
description: >
4-
Check out everything about Flux on our [website](https://fluxcd.io/docs/).
4+
Check out everything about Flux on our [website](https://fluxcd.io/flux/).
55
companies:
66
- name: Weaveworks
77
url: https://weave.works

β€Žconfig.tomlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ weight = 20
185185
[[menus.main]]
186186
name = "Contributing"
187187
parent = "Project"
188-
url = "/docs/contributing"
188+
url = "/contributing"
189189
weight = 30
190190

191191
[[menus.main]]

β€Žcontent/en/_index.htmlβ€Ž

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<div class="hero-gitops">
1515
{{% blocks/hero title="Flux - the GitOps family of projects" color="primary"
16-
height="full" link_title="Get started" link_url="/docs/get-started/" %}}
16+
height="full" link_title="Get started" link_url="/flux/get-started/" %}}
1717
Flux is a set of continuous and progressive delivery solutions for Kubernetes that are open and extensible.
1818

1919
The latest version of Flux brings many new features, making it more flexible and versatile.
@@ -30,7 +30,7 @@ <h2 id="flux-facts">Flux in short</h2>
3030
</div>
3131
</div>
3232

33-
<!-- used in ./content/en/docs/_index.md as well -->
33+
<!-- used in ./content/en/flux/_index.md as well -->
3434

3535
<div id="feature-list">
3636
{{% blocks/section color="white" %}}
@@ -49,7 +49,7 @@ <h2 id="flux-facts">Flux in short</h2>
4949
{{< /blocks/featureitem >}}
5050

5151
{{< blocks/featureitem emoji="πŸ”’" caption="Flux is designed with security in mind" >}}
52-
Pull vs. Push, least amount of privileges, adherence to Kubernetes security policies and tight integration with security tools and best-practices. Read more about <a href="/docs/security">our security considerations</a>.
52+
Pull vs. Push, least amount of privileges, adherence to Kubernetes security policies and tight integration with security tools and best-practices. Read more about <a href="/flux/security">our security considerations</a>.
5353
{{< /blocks/featureitem >}}
5454

5555
{{< blocks/featureitem emoji="☸️" caption="Flux works with any Kubernetes and all common Kubernetes tooling" >}}
@@ -61,7 +61,7 @@ <h2 id="flux-facts">Flux in short</h2>
6161
{{< /blocks/featureitem >}}
6262

6363
{{< blocks/featureitem emoji="πŸ“ž" caption="Flux alerts and notifies" >}}
64-
Flux provides health assessments, alerting to external systems, and external events handling. Just β€œgit push”, and get notified on Slack and <a href="/docs/components/notification/provider/">other chat systems</a>.
64+
Flux provides health assessments, alerting to external systems, and external events handling. Just β€œgit push”, and get notified on Slack and <a href="/flux/components/notification/provider/">other chat systems</a>.
6565
{{< /blocks/featureitem >}}
6666

6767
{{< blocks/featureitem emoji="πŸ‘" caption="Users trust Flux" >}}
@@ -267,8 +267,8 @@ <h2 class="section-label">Other Flux projects</h2>
267267
<p id="gitops-toolkit"></p>
268268
{{% blocks/project title="GitOps Toolkit"
269269
image="/img/building-blocks.svg" image-align="left" bg-color="blue"
270-
button1-url="/docs/gitops-toolkit/source-watcher/"
271-
button2-url="/docs/components/" %}}
270+
button1-url="/flux/gitops-toolkit/source-watcher/"
271+
button2-url="/flux/components/" %}}
272272
The set of APIs and controllers that make up the runtime for Flux. You can use the GitOps Toolkit to extend Flux, and to build your own systems for continuous delivery.
273273
{{% /blocks/project %}}
274274

@@ -278,7 +278,7 @@ <h2 class="section-label">Other Flux projects</h2>
278278
button2-url="/legacy/helm-operator/" button2-caption="Helm Operator Documentation" button2-color="blue" %}}
279279
We owe our success and good reputation as GitOps project to Flux and Helm Operator. They are the v1 iteration of our project and currently in [maintenance mode](https://github.com/fluxcd/flux/issues/3320).
280280

281-
We **strongly advise** everyone to familiarise themselves with the latest version of Flux and [start the process of migrating](/docs/migration/).
281+
We **strongly advise** everyone to familiarise themselves with the latest version of Flux and [start the process of migrating](/flux/migration/).
282282
{{% /blocks/project %}}
283283

284284
{{% /blocks/section %}}

β€Žcontent/en/blog/2020-12-01-december-update/index.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To get you started with setting up Flux and managing multi-tenant environments,
2727

2828
## Guides for Helm users
2929

30-
If you have been using the Helm Operator in the past, you should be able to easily upgrade to the Helm Controller (Flux v2). Check out [this guide](/docs/migration/helm-operator-migration/) and please give us feedback - we’d love to hear from you:
30+
If you have been using the Helm Operator in the past, you should be able to easily upgrade to the Helm Controller (Flux v2). Check out [this guide](/flux/migration/helm-operator-migration/) and please give us feedback - we’d love to hear from you:
3131

3232
If you are interested in an example which describes how you can keep e.g. two clusters updated with minimal duplication, check out this repository - it uses Flux v2, Helm and Kustomize:
3333

β€Žcontent/en/blog/2021-01-06-january-update.mdβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ improvements, it comes with many new features. The highlights are:
7676
Automated Image Updates
7777
-----------------------
7878

79-
[Automated Image Updates Guide](/docs/guides/image-update/) (alpha release)
79+
[Automated Image Updates Guide](/flux/guides/image-update/) (alpha release)
8080

8181
Flux v2 now includes two controllers for automating image updates \--
8282
one of the controllers is for scanning container image repositories, and
@@ -112,7 +112,7 @@ Azure DevOps users will have to specify to use libgit2 in their
112112
GitRepository resources.
113113

114114
Follow [the generic git server
115-
guide](/docs/installation/#generic-git-server)
115+
guide](/flux/installation/#generic-git-server)
116116
for further instructions in how to use Flux with Azure DevOps.
117117

118118
Upcoming events
@@ -130,7 +130,7 @@ Upcoming events
130130
The Flux community is growing and we are in the middle of a quite a few
131131
big discussions:
132132

133-
- We have [a new guide which explains core concepts](/docs/concepts/) in the Flux world - please give feedback - and thanks Somtochi!
133+
- We have [a new guide which explains core concepts](/flux/concepts/) in the Flux world - please give feedback - and thanks Somtochi!
134134
- Flux applies to upgrade to CNCF Incubation status: [https://github.com/cncf/toc/pull/567](https://github.com/cncf/toc/pull/567)
135135

136136
If you like what you read and would like to get involved, here are a few
@@ -139,7 +139,7 @@ good ways to do that:
139139
- Join our [upcoming dev meeting](/community/#meetings) on Jan 14
140140
- Talk to us in the \#flux channel on [CNCF Slack](https://slack.cncf.io/)
141141
- Join the [planning discussions](https://github.com/fluxcd/flux2/discussions)
142-
- And if you are completely new to Flux v2, take a look at our [Get Started guide](/docs/get-started/) and give us feedback
142+
- And if you are completely new to Flux v2, take a look at our [Get Started guide](/flux/get-started/) and give us feedback
143143
- Social media: Follow [Flux on Twitter](https://twitter.com/fluxcd), join the discussion in the [Flux LinkedIn group](https://www.linkedin.com/groups/8985374/)
144144

145145
We are looking forward to working with you.

β€Žcontent/en/blog/2021-02-01-february-update.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ good ways to do that:
210210
- Talk to us in the \#flux channel on [CNCF Slack](https://slack.cncf.io/)
211211
- Join the [planning discussions](https://github.com/fluxcd/flux2/discussions)
212212
- And if you are completely new to Flux v2, take a look at our [Get
213-
Started guide](/docs/get-started/) and give us feedback
213+
Started guide](/flux/get-started/) and give us feedback
214214
- Social media: Follow [Flux on Twitter](https://twitter.com/fluxcd), join the
215215
discussion in the [Flux LinkedIn group](https://www.linkedin.com/groups/8985374/).
216216

β€Žcontent/en/blog/2021-03-01-march-update/index.mdβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Capili](https://www.meetup.com/GitOps-Community/events/276539791/)
109109
> Flux v2.
110110
>
111111
> In this session, Leigh Capili, DX Engineer at Weaveworks, will demo
112-
> the [Flux guide on how to Migrate from Flux v1](/docs/migration/flux-v1-migration/),
112+
> the [Flux guide on how to Migrate from Flux v1](/flux/migration/flux-v1-migration/),
113113
> including bootstrapping a cluster with Flux 1 and how to move it over
114114
> to Flux v2.
115115
>
@@ -119,9 +119,9 @@ Capili](https://www.meetup.com/GitOps-Community/events/276539791/)
119119
>
120120
> Resources:
121121
>
122-
> πŸ“ [Flux v2 Documentation](/docs/)
122+
> πŸ“ [Flux v2 Documentation](/flux/)
123123
>
124-
> πŸ“ [Flux v2 Guide Migrate from Flux v1](/docs/migration/flux-v1-migration/)
124+
> πŸ“ [Flux v2 Guide Migrate from Flux v1](/flux/migration/flux-v1-migration/)
125125
>
126126
> πŸ“ [Flux v2 roadmap](/roadmap/).
127127
@@ -169,7 +169,7 @@ good ways to do that:
169169
- Talk to us in the `#flux` channel on [CNCF Slack](https://slack.cncf.io/)
170170
- Join the [planning discussions](https://github.com/fluxcd/flux2/discussions)
171171
- And if you are completely new to Flux v2, take a look at our
172-
[Get Started guide](/docs/get-started/) and
172+
[Get Started guide](/flux/get-started/) and
173173
give us feedback
174174
- Social media: Follow [Flux on Twitter](https://twitter.com/fluxcd),
175175
join the discussion in the [Flux LinkedIn

0 commit comments

Comments
Β (0)