From 9b24087376fb81734e9981aa389dd11947fb65c1 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Wed, 15 Apr 2020 15:12:33 +0200 Subject: [PATCH 1/3] fix link checking one more time, drop GH Action - use find instead --- .github/workflows/docs.yaml | 25 ++++++++++--------- .../workflows/markdown-link-check-config.json | 9 +++---- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 0da6c38f6..dfe656236 100644 --- a/.github/workflows/docs.yaml +++ b/.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: diff --git a/.github/workflows/markdown-link-check-config.json b/.github/workflows/markdown-link-check-config.json index 421a2d3a2..761426f47 100644 --- a/.github/workflows/markdown-link-check-config.json +++ b/.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" } ] } From 03b6a451f2ec682e3ea5042a29abee78cbffac17 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Wed, 15 Apr 2020 15:12:54 +0200 Subject: [PATCH 2/3] fix a bunch of links in the chart docs --- chart/flux/README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/chart/flux/README.md b/chart/flux/README.md index af25da1af..30838dbbb 100755 --- a/chart/flux/README.md +++ b/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 +[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 From bbd176ef5ae574dc6c872c51df1db1a5289f1354 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Wed, 15 Apr 2020 15:13:30 +0200 Subject: [PATCH 3/3] actually update to new version of material theme (https://squidfunk.github.io/mkdocs-material/releases/5/#how-to-upgrade) --- mkdocs.yml | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index e83bde4dd..df5acd000 100644 --- a/mkdocs.yml +++ b/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/flux-icon@2x.png language: en - feature: - tabs: false palette: primary: blue accent: indigo @@ -25,10 +23,6 @@ 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 @@ -36,7 +30,7 @@ markdown_extensions: guess_lang: false - toc: permalink: true - - pymdownx.superfences + - pymdownx.tabbed nav: - Introducing Flux: introduction.md