explain where docs are
keep netlify config for now (disabled in the app), but only make it ship the _redirects file add rule for 'install.sh' move _redirects file into docs/ directory document redirects and Netlify Signed-off-by: Daniel Holbach <daniel@weave.works>
This commit is contained in:
17
docs/README.md
Normal file
17
docs/README.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Flux v2 Documentation
|
||||
|
||||
The documentation for `flux2` has moved to this repository: <https://github.com/fluxcd/website>.
|
||||
|
||||
[The Website's README](https://github.com/fluxcd/website/#readme) has information on how to
|
||||
|
||||
- modify and extend documentation
|
||||
- run the site <https://fluxcd.io> locally
|
||||
- publish changes
|
||||
|
||||
and where all the individual pieces of content come from.
|
||||
|
||||
It will be easier for us to maintain a coherent web presences (and merge all of Flux documentation) in one central repository. This was partly discussed in <https://github.com/fluxcd/flux2/discussions/367>.
|
||||
|
||||
## toolkit.fluxcd.io
|
||||
|
||||
For historical reasons we are keeping a `_redirects` file in this directory. It defines how redirects from the old site `toolkit.fluxcd.io` to our new website <https://fluxcd.io> work. Changes to this file need to be merged and a manual build triggered in the Netlify App.
|
||||
18
docs/_redirects
Normal file
18
docs/_redirects
Normal file
@@ -0,0 +1,18 @@
|
||||
# individual rules
|
||||
/core-concepts https://fluxcd.io/docs/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!
|
||||
|
||||
|
||||
# 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!
|
||||
|
||||
|
||||
# catch all
|
||||
/* https://fluxcd.io/docs/:splat 301!
|
||||
Reference in New Issue
Block a user