Merge pull request #3007 from fluxcd/fix-3004

Attempt fixing 404 pages, update mkdocs options to material 5 theme, fix links and link checking

.github/workflows/docs.yaml

@@ -15,18 +15,19 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       # Using markdown-link-check to check markdown docs
-      - name: Link Checker (for top-level markdown docs)
-        uses: gaurav-nelson/github-action-markdown-link-check@v1
-        with:
-          use-verbose-mode: 'yes'
-          config-file: '.github/workflows/markdown-link-check-config.json'
-          folder-path: ./
-          max-depth: 1
-      - name: Link Checker (for ./internal markdown docs)
-        uses: gaurav-nelson/github-action-markdown-link-check@v1
-        with:
-          use-verbose-mode: 'yes'
-          folder-path: ./internal/docs/
+      - name: Install markdown-link-check
+        run: |
+          npm i markdown-link-check
+
+      - name: Check non-docs markdown files
+        run: |
+          find . \
+            -name docs -prune -o \
+            -name node_modules -prune -o \
+            -name vendor -prune -o \
+            -iname '*.md' \
+            -exec ./node_modules/markdown-link-check/markdown-link-check --config .github/workflows/markdown-link-check-config.json {} \;
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v1
         with:

.github/workflows/markdown-link-check-config.json

@@ -1,9 +1,8 @@
 {
     "ignorePatterns": [
-        {
-            "githubIssuePattern": "^https://github.com/\\S+/\\S+/(issues|pull)/[0-9]+",
-            "mailtoPattern": "^mailto:",
-            "companySitesWith403sPattern": "^https://www.(blablacar|canva|underarmour).com"
-        }
+        { "pattern": "^https://github.com/\\S+/\\S+/(issues|pull)/[0-9]+" },
+        { "pattern": "^mailto:" },
+        { "pattern": "^https://www.(blablacar|canva|underarmour).com" },
+        { "pattern": "https://rakuten.com" }
     ]
 }

chart/flux/README.md

@@ -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.html) which takes about 5-10 minutes to follow.
+tutorial](https://docs.fluxcd.io/en/stable/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
@@ -58,7 +58,7 @@ helm repo add fluxcd https://charts.fluxcd.io
    > **Note:** this not required when [using git over HTTPS](#flux-with-git-over-https).
 
    At startup Flux generates a SSH key and logs the public key. Find the
-   SSH public key by installing [fluxctl](https://docs.fluxcd.io/en/stable/references/fluxctl.html)
+   SSH public key by installing [fluxctl](https://docs.fluxcd.io/en/stable/references/fluxctl)
    and running:
 
    ```sh
@@ -262,22 +262,25 @@ The following tables lists the configurable parameters of the Flux chart and the
 | `memcached.pullSecret`                            | `None`                                               | Image pull secret
 | `memcached.repository`                            | `memcached`                                          | Image repository
 | `memcached.resources`                             | `None`                                               | CPU/memory resource requests/limits for memcached
-| `memcached.securityContext`                       | [See values.yaml](/chart/flux/values.yaml#L176-L179) | Container security context for memcached
+| `memcached.securityContext`                       | [See values.yaml][memcached-reference]               | Container security context for memcached
 | `memcached.nodeSelector`                          | `{}`                                                 | Node Selector properties for the memcached deployment
 | `memcached.tolerations`                           | `[]`                                                 | Tolerations properties for the memcached deployment
 | `memcached.priorityClassName`                     | `""`                                                 | The name of the priority class to assign to the memcached pod.
-| `kube.config`                                     | [See values.yaml](/chart/flux/values.yaml#L200-L212) | Override for kubectl default config in the Flux pod(s).
+| `kube.config`                                     | [See values.yaml][kubeconfig-ref]                    | Override for kubectl default config in the Flux pod(s).
 | `priorityClassName`                               | `""`                                                 | Set priority class for Flux
 | `prometheus.enabled`                              | `false`                                              | If enabled, adds prometheus annotations to Flux and helmOperator pod(s)
 | `prometheus.serviceMonitor.create`                | `false`                                              | Set to true if using the Prometheus Operator
 | `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](../../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))
 | `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/>
 
+[memcached-ref]: https://github.com/fluxcd/flux/blob/master/chart/flux/values.yaml#L201-L204
+[kubeconfig-ref]: https://github.com/fluxcd/flux/blob/master/chart/flux/values.yaml#L232-L244
+
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example:
 
 ```sh

mkdocs.yml

@@ -1,7 +1,7 @@
 site_name: Flux
 site_description: Documentation for Flux, the GitOps Kubernetes operator.
 site_author: The Flux contributors
-site_url: https://docs.fluxcd.io/
+site_url: https://docs.fluxcd.io
 
 # Repository
 repo_name: fluxcd/flux
@@ -12,8 +12,6 @@ theme:
   name: material
   logo: _files/[email protected]
   language: en
-  feature:
-    tabs: false
   palette:
     primary: blue
     accent: indigo
@@ -25,18 +23,14 @@ extra_css:
 
 plugins:
   - search
-    #  - redirects:
-    #  redirect_maps:
-    #    'guides/upgrading-to-ga.md': 'how-to/upgrade-to-ga.md'
-    #    'guides/upgrading-to-beta.md': 'how-to/upgrade-to-beta.md'
 
 markdown_extensions:
   - admonition
   - codehilite:
       guess_lang: false
   - toc:
       permalink: true
-  - pymdownx.superfences
+  - pymdownx.tabbed
 
 nav:
   - Introducing Flux: introduction.md