Browse Source

rename site/ to docs/

Daniel Holbach 1 year ago
parent
commit
fffd8d3550
50 changed files with 43 additions and 75 deletions
  1. 1
    1
      .gitignore
  2. 2
    2
      .readthedocs.yml
  3. 4
    4
      CONTRIBUTING.md
  4. 1
    1
      Makefile
  5. 18
    18
      README.md
  6. 1
    1
      chart/flux/Chart.yaml
  7. 5
    5
      chart/flux/README.md
  8. 1
    1
      chart/flux/templates/NOTES.txt
  9. 1
    1
      daemon/errors.go
  10. 1
    1
      deploy/flux-deployment.yaml
  11. 0
    0
      docs/Dockerfile
  12. 0
    0
      docs/Makefile
  13. 0
    0
      docs/_static/custom.css
  14. 0
    0
      docs/conf.py
  15. 0
    0
      docs/development/building.md
  16. 0
    0
      docs/development/get-started-developing.md
  17. 0
    0
      docs/development/index.rst
  18. 0
    0
      docs/faq.md
  19. 0
    0
      docs/features/daemon.md
  20. 1
    1
      docs/features/fluxyaml-config-files.md
  21. 0
    0
      docs/features/garbagecollection.md
  22. 0
    0
      docs/features/index.rst
  23. 0
    0
      docs/helm/helm-integration.md
  24. 0
    0
      docs/helm/helm-operator.md
  25. 0
    0
      docs/helm/helm-upgrading-to-beta.md
  26. 0
    0
      docs/how-it-works.md
  27. 0
    0
      docs/images/deployment-pipeline.png
  28. 0
    0
      docs/images/flux-cd-diagram.png
  29. 0
    0
      docs/images/weave-flux.png
  30. 0
    0
      docs/index.rst
  31. 0
    0
      docs/install/get-started.md
  32. 0
    0
      docs/install/helm-get-started.md
  33. 0
    0
      docs/install/index.md
  34. 0
    0
      docs/install/standalone-setup.md
  35. 0
    0
      docs/introduction.md
  36. 0
    0
      docs/requirements.md
  37. 0
    0
      docs/requirements.txt
  38. 0
    0
      docs/troubleshooting.md
  39. 0
    0
      docs/using/annotations-tutorial.md
  40. 1
    1
      docs/using/fluxctl.md
  41. 0
    0
      docs/using/git-gpg.md
  42. 0
    0
      docs/using/monitoring.md
  43. 0
    0
      docs/using/upgrading-to-1.0.md
  44. 1
    1
      git/errors.go
  45. 1
    1
      install/templates/flux-deployment.yaml.tmpl
  46. 1
    1
      internal_docs/releasing.md
  47. 1
    1
      release/errors.go
  48. 2
    2
      remote/errors.go
  49. 0
    15
      site/helm/index.rst
  50. 0
    17
      site/using/index.rst

+ 1
- 1
.gitignore View File

@@ -52,4 +52,4 @@ test/bin/helm
52 52
 test/bin/kind
53 53
 
54 54
 # Docs
55
-site/_build
55
+docs/_build

+ 2
- 2
.readthedocs.yml View File

@@ -7,7 +7,7 @@ version: 2
7 7
 
8 8
 # Build documentation in the docs/ directory with Sphinx
9 9
 sphinx:
10
-  configuration: site/conf.py
10
+  configuration: docs/conf.py
11 11
 
12 12
 # Build documentation with MkDocs
13 13
 #mkdocs:
@@ -20,4 +20,4 @@ formats: all
20 20
 python:
21 21
   version: 3.7
22 22
   install:
23
-    - requirements: site/requirements.txt
23
+    - requirements: docs/requirements.txt

+ 4
- 4
CONTRIBUTING.md View File

@@ -18,8 +18,8 @@ the `blocked-needs-validation` label is removed, and the issue can be worked
18 18
 on.
19 19
 
20 20
 To set up Flux to test things, there's documentation about setting up a
21
-[standalone install](site/get-started.md) and a [Helm
22
-install](site/helm-get-started.md), which might be helpful.
21
+[standalone install](docs/get-started.md) and a [Helm
22
+install](docs/helm-get-started.md), which might be helpful.
23 23
 
24 24
 Please talk to us on Slack, if you should get stuck anywhere. We appreciate
25 25
 any help and look forward to talking to you soon!
@@ -73,10 +73,10 @@ This is a rough outline of how to prepare a contribution:
73 73
 
74 74
 ### How to build and run the project
75 75
 
76
-Refer to the [building doc](site/building.md) to find out how to build from
76
+Refer to the [building doc](docs/building.md) to find out how to build from
77 77
 source.
78 78
 
79
-Refer to the [Get Started Developing](site/get-started-developing.md) guide for a walkthrough on developing Flux locally.
79
+Refer to the [Get Started Developing](docs/get-started-developing.md) guide for a walkthrough on developing Flux locally.
80 80
 
81 81
 ### How to run the test suite
82 82
 

+ 1
- 1
Makefile View File

@@ -135,7 +135,7 @@ check-generated: generate-deploy install/generated_templates.gogen.go
135 135
 	git diff --exit-code -- integrations/apis intergrations/client install/generated_templates.gogen.go
136 136
 
137 137
 build-docs:
138
-	@cd site && docker build -t flux-docs .
138
+	@cd docs && docker build -t flux-docs .
139 139
 
140 140
 test-docs: build-docs
141 141
 	@docker run -it flux-docs /usr/bin/linkchecker _build/html/index.html

+ 18
- 18
README.md View File

@@ -31,7 +31,7 @@ change is atomic and transactional, git has your audit log. Each transaction
31 31
 either fails or succeeds cleanly. You're entirely code centric and don't need
32 32
 new infrastructure.
33 33
 
34
-![Deployment Pipeline](site/images/flux-cd-diagram.png)
34
+![Deployment Pipeline](docs/images/flux-cd-diagram.png)
35 35
 
36 36
 [![CircleCI](https://circleci.com/gh/fluxcd/flux.svg?style=svg)](https://circleci.com/gh/fluxcd/flux)
37 37
 [![GoDoc](https://godoc.org/github.com/fluxcd/flux?status.svg)](https://godoc.org/github.com/fluxcd/flux)
@@ -46,9 +46,9 @@ container images and config changes are propagated to the cluster.
46 46
 
47 47
 Its major features are:
48 48
 
49
-- [Automated git → cluster synchronisation](/site/introduction.md#automated-git-cluster-synchronisation)
50
-- [Automated deployment of new container images](/site/introduction.md#automated-deployment-of-new-container-images)
51
-- [Integrations with other devops tools](/site/introduction.md#integrations-with-other-devops-tools) ([Helm](/site/helm-integration.md) and more)
49
+- [Automated git → cluster synchronisation](/docs/introduction.md#automated-git-cluster-synchronisation)
50
+- [Automated deployment of new container images](/docs/introduction.md#automated-deployment-of-new-container-images)
51
+- [Integrations with other devops tools](/docs/introduction.md#integrations-with-other-devops-tools) ([Helm](/docs/helm-integration.md) and more)
52 52
 - No additional service or infrastructure needed - Flux lives inside your
53 53
   cluster
54 54
 - Straight-forward control over the state of deployments in the
@@ -99,21 +99,21 @@ could easily integrate.
99 99
 Get started by browsing through the documentation below:
100 100
 
101 101
 - Background about Flux
102
-  - [Introduction to Flux](/site/introduction.md)
103
-  - [FAQ](/site/faq.md) and [frequently encountered issues](https://github.com/fluxcd/flux/labels/FAQ)
104
-  - [How it works](/site/how-it-works.md)
105
-  - [Considerations regarding installing Flux](/site/installing.md)
106
-  - [Flux <-> Helm integration](/site/helm-integration.md)
102
+  - [Introduction to Flux](/docs/introduction.md)
103
+  - [FAQ](/docs/faq.md) and [frequently encountered issues](https://github.com/fluxcd/flux/labels/FAQ)
104
+  - [How it works](/docs/how-it-works.md)
105
+  - [Considerations regarding installing Flux](/docs/installing.md)
106
+  - [Flux <-> Helm integration](/docs/helm-integration.md)
107 107
 - Get Started with Flux
108
-  - [Standalone Flux](/site/get-started.md)
109
-  - [Flux using Helm](/site/helm-get-started.md)
110
-  - [Automation: annotations and locks](/site/annotations-tutorial.md)
108
+  - [Standalone Flux](/docs/get-started.md)
109
+  - [Flux using Helm](/docs/helm-get-started.md)
110
+  - [Automation: annotations and locks](/docs/annotations-tutorial.md)
111 111
 - Operating Flux
112
-  - [Using fluxctl to control Flux](/site/fluxctl.md)
113
-  - [Helm Operator](/site/helm-operator.md)
114
-  - [Troubleshooting](/site/troubleshooting.md)
112
+  - [Using fluxctl to control Flux](/docs/fluxctl.md)
113
+  - [Helm Operator](/docs/helm-operator.md)
114
+  - [Troubleshooting](/docs/troubleshooting.md)
115 115
   - [Frequently encountered issues](https://github.com/fluxcd/flux/labels/FAQ)
116
-  - [Upgrading to Flux v1](/site/upgrading-to-1.0.md)
116
+  - [Upgrading to Flux v1](/docs/upgrading-to-1.0.md)
117 117
 
118 118
 ### Integrations
119 119
 
@@ -142,14 +142,14 @@ To familiarise yourself with the project and how things work, you might
142 142
 be interested in the following:
143 143
 
144 144
 - [Our contributions guidelines](CONTRIBUTING.md)
145
-- [Build documentation](/site/building.md)
145
+- [Build documentation](/docs/building.md)
146 146
 - [Release documentation](/internal_docs/releasing.md)
147 147
 
148 148
 ## <a name="help"></a>Getting Help
149 149
 
150 150
 If you have any questions about Flux and continuous delivery:
151 151
 
152
-- Read [the Flux docs](https://github.com/fluxcd/flux/tree/master/site).
152
+- Read [the Flux docs](https://github.com/fluxcd/flux/tree/master/docs).
153 153
 - Invite yourself to the <a href="https://slack.cncf.io" target="_blank">CNCF community</a>
154 154
   slack and ask a question on the [#flux](https://cloud-native.slack.com/messages/flux/)
155 155
   channel.

+ 1
- 1
chart/flux/Chart.yaml View File

@@ -11,6 +11,6 @@ maintainers:
11 11
   - name: stefanprodan
12 12
     email: stefan@weave.works
13 13
 engine: gotpl
14
-icon: https://raw.githubusercontent.com/fluxcd/flux/master/site/images/weave-flux.png
14
+icon: https://raw.githubusercontent.com/fluxcd/flux/master/docs/images/weave-flux.png
15 15
 keywords:
16 16
   - gitops

+ 5
- 5
chart/flux/README.md View File

@@ -22,7 +22,7 @@ This means fluxd can fail to apply changes to HelmRelease resources.
22 22
 ### Helm
23 23
 
24 24
 Tiller should be running in the cluster, though
25
-[helm-operator](../../site/helm-operator.md) will wait
25
+[helm-operator](../../docs/helm-operator.md) will wait
26 26
 until it can find one.
27 27
 
28 28
 # Git repo
@@ -37,7 +37,7 @@ until it can find one.
37 37
 ## Installation
38 38
 
39 39
 We put together a simple [Get Started
40
-guide](../../site/helm-get-started.md) which takes about 5-10 minutes to follow.
40
+guide](../../docs/helm-get-started.md) which takes about 5-10 minutes to follow.
41 41
 You will have a fully working Flux installation deploying workloads to your cluster.
42 42
 
43 43
 ## Installing Flux using Helm
@@ -154,7 +154,7 @@ The [configuration](#configuration) section lists all the parameters that can be
154 154
 #### Setup Git deploy
155 155
 
156 156
 At startup Flux generates a SSH key and logs the public key.
157
-Find the SSH public key by installing [fluxctl](../../site/fluxctl.md) and
157
+Find the SSH public key by installing [fluxctl](../../docs/fluxctl.md) and
158 158
 running:
159 159
 
160 160
 ```sh
@@ -288,8 +288,8 @@ The following tables lists the configurable parameters of the Flux chart and the
288 288
 | `helmOperator.affinity`                           | `{}`                                                 | Affinity properties for the helmOperator deployment
289 289
 | `kube.config`                                     | [See values.yaml](/chart/flux/values.yaml#L151-L165) | Override for kubectl default config in the Flux pod(s).
290 290
 | `prometheus.enabled`                              | `false`                                              | If enabled, adds prometheus annotations to Flux and helmOperator pod(s)
291
-| `syncGarbageCollection.enabled`                   | `false`                                              | If enabled, fluxd will delete resources that it created, but are no longer present in git (experimental, see [garbage collection](/site/garbagecollection.md))
292
-| `syncGarbageCollection.dry`                       | `false`                                              | If enabled, fluxd won't delete any resources, but log the garbage collection output (experimental, see [garbage collection](/site/garbagecollection.md))
291
+| `syncGarbageCollection.enabled`                   | `false`                                              | If enabled, fluxd will delete resources that it created, but are no longer present in git (experimental, see [garbage collection](/docs/garbagecollection.md))
292
+| `syncGarbageCollection.dry`                       | `false`                                              | If enabled, fluxd won't delete any resources, but log the garbage collection output (experimental, see [garbage collection](/docs/garbagecollection.md))
293 293
 
294 294
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example:
295 295
 

+ 1
- 1
chart/flux/templates/NOTES.txt View File

@@ -3,7 +3,7 @@ Get the Git deploy key by either (a) running
3 3
   kubectl -n {{ .Release.Namespace }} logs deployment/{{ .Release.Name }} | grep identity.pub | cut -d '"' -f2
4 4
 
5 5
 or by (b) installing fluxctl through
6
-https://github.com/weaveworks/flux/blob/master/site/fluxctl.md#installing-fluxctl
6
+https://github.com/weaveworks/flux/blob/master/docs/fluxctl.md#installing-fluxctl
7 7
 and running:
8 8
 
9 9
   fluxctl identity

+ 1
- 1
daemon/errors.go View File

@@ -28,7 +28,7 @@ giving this error:
28 28
 Check that any files mentioned are well-formed, and resources are not
29 29
 defined more than once. It's also worth reviewing
30 30
 
31
-    https://github.com/weaveworks/flux/blob/master/site/requirements.md
31
+    https://github.com/weaveworks/flux/blob/master/docs/requirements.md
32 32
 
33 33
 to make sure you're not running into any corner cases.
34 34
 

+ 1
- 1
deploy/flux-deployment.yaml View File

@@ -35,7 +35,7 @@ spec:
35 35
       # file, which you will need to do if you host your own git
36 36
       # repo rather than using github or the like. You'll also need to
37 37
       # mount it into the container, below. See
38
-      # https://github.com/weaveworks/flux/blob/master/site/standalone-setup.md#using-a-private-git-host
38
+      # https://github.com/weaveworks/flux/blob/master/docs/standalone-setup.md#using-a-private-git-host
39 39
       # - name: ssh-config
40 40
       #   configMap:
41 41
       #     name: flux-ssh-config

site/Dockerfile → docs/Dockerfile View File


site/Makefile → docs/Makefile View File


site/_static/custom.css → docs/_static/custom.css View File


site/conf.py → docs/conf.py View File


site/development/building.md → docs/development/building.md View File


site/development/get-started-developing.md → docs/development/get-started-developing.md View File


site/development/index.rst → docs/development/index.rst View File


site/faq.md → docs/faq.md View File


site/features/daemon.md → docs/features/daemon.md View File


site/features/fluxyaml-config-files.md → docs/features/fluxyaml-config-files.md View File

@@ -26,7 +26,7 @@ Flux performs two types of actions on raw manifest files from the Git repository
26 26
 
27 27
 1. Read manifest files when performing a sync operation (i.e making sure that the status of the cluster reflects what's
28 28
    in the manifest files, adjusting it if necessary)
29
-2. Update the manifest files of [workload](https://github.com/weaveworks/flux/blob/master/site/fluxctl.md#what-is-a-workload).
29
+2. Update the manifest files of [workload](https://github.com/weaveworks/flux/blob/master/docs/fluxctl.md#what-is-a-workload).
30 30
    Specifically, flux can update:
31 31
     * container images, when releasing a new image version. A release can happen manually or automatically, when a new
32 32
       container image is pushed to a repository.

site/features/garbagecollection.md → docs/features/garbagecollection.md View File


site/features/index.rst → docs/features/index.rst View File


site/helm/helm-integration.md → docs/helm/helm-integration.md View File


site/helm/helm-operator.md → docs/helm/helm-operator.md View File


site/helm/helm-upgrading-to-beta.md → docs/helm/helm-upgrading-to-beta.md View File


site/how-it-works.md → docs/how-it-works.md View File


site/images/deployment-pipeline.png → docs/images/deployment-pipeline.png View File


site/images/flux-cd-diagram.png → docs/images/flux-cd-diagram.png View File


site/images/weave-flux.png → docs/images/weave-flux.png View File


site/index.rst → docs/index.rst View File


site/install/get-started.md → docs/install/get-started.md View File


site/install/helm-get-started.md → docs/install/helm-get-started.md View File


site/install/index.md → docs/install/index.md View File


site/install/standalone-setup.md → docs/install/standalone-setup.md View File


site/introduction.md → docs/introduction.md View File


site/requirements.md → docs/requirements.md View File


site/requirements.txt → docs/requirements.txt View File


site/troubleshooting.md → docs/troubleshooting.md View File


site/using/annotations-tutorial.md → docs/using/annotations-tutorial.md View File


site/using/fluxctl.md → docs/using/fluxctl.md View File

@@ -556,7 +556,7 @@ Commit customization
556 556
         --git-user
557 557
         --git-email
558 558
 
559
-        See [site/daemon.md] for more information.
559
+        See [docs/daemon.md] for more information.
560 560
 
561 561
     3. Commit author
562 562
 

site/using/git-gpg.md → docs/using/git-gpg.md View File


site/using/monitoring.md → docs/using/monitoring.md View File


site/using/upgrading-to-1.0.md → docs/using/upgrading-to-1.0.md View File


+ 1
- 1
git/errors.go View File

@@ -16,7 +16,7 @@ We need to clone a git repo to proceed, and you haven't supplied
16 16
 one. Please upload a config file, including a git repository URL, as
17 17
 described in
18 18
 
19
-    https://github.com/weaveworks/flux/blob/master/site/fluxctl.md
19
+    https://github.com/weaveworks/flux/blob/master/docs/fluxctl.md
20 20
 
21 21
 `,
22 22
 }

+ 1
- 1
install/templates/flux-deployment.yaml.tmpl View File

@@ -36,7 +36,7 @@ spec:
36 36
       # file, which you will need to do if you host your own git
37 37
       # repo rather than using github or the like. You'll also need to
38 38
       # mount it into the container, below. See
39
-      # https://github.com/weaveworks/flux/blob/master/site/standalone-setup.md#using-a-private-git-host
39
+      # https://github.com/weaveworks/flux/blob/master/docs/standalone-setup.md#using-a-private-git-host
40 40
       # - name: ssh-config
41 41
       #   configMap:
42 42
       #     name: flux-ssh-config

+ 1
- 1
internal_docs/releasing.md View File

@@ -4,7 +4,7 @@ The release process needs to do these things:
4 4
 
5 5
  - create a new release on GitHub, with a tag
6 6
  - push Docker image(s) to Docker Hub
7
- - possibly upload the [`fluxctl` binaries](/site/fluxctl.md#binary-releases) to the GitHub release
7
+ - possibly upload the [`fluxctl` binaries](/docs/fluxctl.md#binary-releases) to the GitHub release
8 8
  - make sure the version is entered into the checkpoint database so that up-to-date checks report back accurate information
9 9
  - close out the GitHub milestone that was used to track the release
10 10
 

+ 1
- 1
release/errors.go View File

@@ -14,7 +14,7 @@ func MakeReleaseError(err error) *fluxerr.Error {
14 14
 This may be because of a limitation in the formats of file Flux can
15 15
 deal with. See
16 16
 
17
-    https://github.com/weaveworks/flux/blob/master/site/requirements.md
17
+    https://github.com/weaveworks/flux/blob/master/docs/requirements.md
18 18
 
19 19
 for those limitations.
20 20
 

+ 2
- 2
remote/errors.go View File

@@ -22,7 +22,7 @@ and try the operation again.
22 22
 Otherwise, please consult the installation instructions in our
23 23
 documentation:
24 24
 
25
-    https://github.com/weaveworks/flux/blob/master/site/installing.md
25
+    https://github.com/weaveworks/flux/blob/master/docs/installing.md
26 26
 
27 27
 If you are still stuck, please log an issue:
28 28
 
@@ -89,7 +89,7 @@ Otherwise, it is likely to be an ongoing problem until fluxd is
89 89
 updated and/or redeployed. For help, please consult the installation
90 90
 instructions:
91 91
 
92
-    https://github.com/weaveworks/flux/blob/master/site/installing.md
92
+    https://github.com/weaveworks/flux/blob/master/docs/installing.md
93 93
 
94 94
 If you are still stuck, please log an issue:
95 95
 

+ 0
- 15
site/helm/index.rst View File

@@ -1,15 +0,0 @@
1
-.. Flux documentation documentation master file, created by
2
-   sphinx-quickstart on Wed Jun 12 16:13:18 2019.
3
-   You can adapt this file completely to your liking, but it should at least
4
-   contain the root `toctree` directive.
5
-
6
-Using Flux with Helm
7
-==============================================
8
-
9
-.. toctree::
10
-   :maxdepth: 2
11
-   :caption: Contents:
12
-
13
-   helm-integration
14
-   helm-operator
15
-   helm-upgrading-to-beta

+ 0
- 17
site/using/index.rst View File

@@ -1,17 +0,0 @@
1
-.. Flux documentation documentation master file, created by
2
-   sphinx-quickstart on Wed Jun 12 16:13:18 2019.
3
-   You can adapt this file completely to your liking, but it should at least
4
-   contain the root `toctree` directive.
5
-
6
-Using Flux
7
-==============================================
8
-
9
-.. toctree::
10
-   :maxdepth: 1
11
-   :caption: Contents:
12
-
13
-   annotations-tutorial
14
-   fluxctl
15
-   git-gpg
16
-   monitoring
17
-   upgrading-to-1.0

Loading…
Cancel
Save