Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Commit

Permalink
fix link-checking (follow fluxcd/flux#2956)
Browse files Browse the repository at this point in the history
	move back to upstream GH action
	update pymdown-extensions
	update to mkdocs-material 5: https://squidfunk.github.io/mkdocs-material/releases/5/#how-to-upgrade
	fix links
	follow fluxcd/flux#3006
	parallelise checking
  • Loading branch information
Daniel Holbach committed Apr 28, 2020
1 parent e881eed commit ba2c78e
Show file tree
Hide file tree
Showing 15 changed files with 103 additions and 46 deletions.
34 changes: 28 additions & 6 deletions .github/workflows/check-links.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,30 @@
on: [push, pull_request]
name: Check links
name: docs

on:
pull_request:
push:
branches:
- master

jobs:
linkChecker:
link-checker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- 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 {} \;
# Using liche action to check generated HTML site
site-link-checker:
runs-on: ubuntu-latest
strategy:
matrix:
Expand All @@ -14,14 +37,13 @@ jobs:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Build docs for link check
run: mkdocs build
- name: Link Checker
- name: Link Checker (generated site)
id: lc
uses: peter-evans/link-checker@v1
with:
args: -r -d site/ -v site/index.html
args: -d ./site -r ./site
- name: Fail if there were link errors
run: exit ${{ steps.lc.outputs.exit_code }}
6 changes: 6 additions & 0 deletions .github/workflows/markdown-link-check-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"ignorePatterns": [
{ "pattern": "^https://github.com/\\S+/\\S+/(issues|pull)/[0-9]+" },
{ "pattern": "^mailto:" }
]
}
22 changes: 14 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to Contribute

The Helm Operator is [Apache 2.0 licensed](LICENSE) and accepts contributions
The Helm Operator is [Apache 2.0 licensed](https://github.com/fluxcd/helm-operator/blob/master/LICENSE) and accepts contributions
via GitHub pull requests. This document outlines some of the conventions on development
workflow, commit message formatting, contact points and other resources to make
it easier to get your contribution accepted.
Expand Down Expand Up @@ -29,7 +29,7 @@ By contributing to this project you agree to the Developer Certificate of
Origin (DCO). This document was created by the Linux Kernel community and is a
simple statement that you, as a contributor, have the legal right to make the
contribution. No action from you is required, but it's a good idea to see the
[DCO](DCO) file for details before you start contributing code to Helm Operator.
[DCO](https://github.com/fluxcd/helm-operator/blob/master/DCO) file for details before you start contributing code to Helm Operator.

## Communications

Expand All @@ -39,14 +39,20 @@ The project uses Slack: To join the conversation, simply join the

The Flux developers use a mailing list to discuss development as well.
Simply subscribe to [flux-dev on cncf.io](https://lists.cncf.io/g/cncf-flux-dev)
to join the conversation (this will also add an invitation to your
Google calendar for our [Flux
meeting](https://docs.google.com/document/d/1l_M0om0qUEN_NNiGgpqJ2tvsF2iioHkaARDeh6b70B0/edit#)).
to join the conversation.

### Meetings

Agenda and minutes of previous Flux Dev meetings can be reviewed in this
[Google doc](https://docs.google.com/document/d/1l_M0om0qUEN_NNiGgpqJ2tvsF2iioHkaARDeh6b70B0/edit#).

Meeting recordings can be viewed in this [Youtube
playlist](https://www.youtube.com/playlist?list=PLbx4FZ4kOKntmgJqaT-iJ8tn4xat150yL).

## Getting Started

- Fork the repository on GitHub
- Read the [README](README.md#get-started-with-the-helm-operator) for getting started as
- Read the [README](https://github.com/fluxcd/helm-operator/blob/master/README.md#get-started-with-the-helm-operator) for getting started as
a user and learn how/where to ask for help
- If you want to contribute as a developer, continue reading this document for further instructions
- If you are a new contributor, the following two issue labels might be
Expand All @@ -72,10 +78,10 @@ This is a rough outline of how to prepare a contribution:

### How to build and run the project

Refer to the [Building](https://docs.fluxcd.io/projects/helm-operator/en/stable/contributing/building/) guide to find out how to build from
Refer to the [Building](https://docs.fluxcd.io/en/stable/contributing/building/) guide to find out how to build from
source.

Refer to the [Get started developing](https://docs.fluxcd.io/projects/helm-operator/en/stable/contributing/get-started-developing/) guide
Refer to the [Get started developing](https://docs.fluxcd.io/en/stable/contributing/get-started-developing/) guide
for a walkthrough on developing Helm Operator locally.

### How to run the test suite
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ performed by the operator.
or a (local) URL
* Automated purging on release install failures
* Automated (optional) rollback on upgrade failures
* Automated image upgrades [using Flux](https://docs.fluxcd.io/en/stable/references/helm-operator-integration.html)
* Automated image upgrades [using Flux](https://docs.fluxcd.io/en/stable/references/helm-operator-integration)
* Automated (configurable) chart dependency updates for Helm charts
from Git sources on install or upgrade
* Detection and recovery from Helm storage mutations
Expand Down Expand Up @@ -72,7 +72,7 @@ To familiarise yourself with the project and how things work, you might
be interested in the following:

- [Our contributions guidelines](CONTRIBUTING.md)
- [Build documentation](https://docs.fluxcd.io/en/stable/contributing/building.html)
- [Build documentation](https://docs.fluxcd.io/en/stable/contributing/building)
- [Release documentation](internal_docs/releasing.md)

## <a name="help"></a>Getting Help
Expand Down
8 changes: 4 additions & 4 deletions chart/helm-operator/crds/helmrelease.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ spec:
name:
type: string
git:
description: Git URL is the URL of the Git repository, e.g. [email protected]:org/repo,
http://github.com/org/repo, or ssh://[email protected]:2222/org/repo.git.
description: Git URL is the URL of the Git repository, e.g. `[email protected]:org/repo`,
`http://github.com/org/repo`, or `ssh://[email protected]:2222/org/repo.git`.
type: string
name:
description: Name is the name of the Helm chart _without_ an alias,
Expand All @@ -95,8 +95,8 @@ spec:
Defaults to 'master', or the configured default Git ref.
type: string
repository:
description: RepoURL is the URL of the Helm repository, e.g. https://kubernetes-charts.storage.googleapis.com
or https://charts.example.com.
description: RepoURL is the URL of the Helm repository, e.g. `https://kubernetes-charts.storage.googleapis.com`
or `https://charts.example.com`.
type: string
secretRef:
description: SecretRef holds the authentication secret for accessing
Expand Down
8 changes: 4 additions & 4 deletions deploy/crds.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ spec:
name:
type: string
git:
description: Git URL is the URL of the Git repository, e.g. [email protected]:org/repo,
http://github.com/org/repo, or ssh://[email protected]:2222/org/repo.git.
description: Git URL is the URL of the Git repository, e.g. `[email protected]:org/repo`,
`http://github.com/org/repo`, or `ssh://[email protected]:2222/org/repo.git`.
type: string
name:
description: Name is the name of the Helm chart _without_ an alias,
Expand All @@ -96,8 +96,8 @@ spec:
Defaults to 'master', or the configured default Git ref.
type: string
repository:
description: RepoURL is the URL of the Helm repository, e.g. https://kubernetes-charts.storage.googleapis.com
or https://charts.example.com.
description: RepoURL is the URL of the Helm repository, e.g. `https://kubernetes-charts.storage.googleapis.com`
or `https://charts.example.com`.
type: string
secretRef:
description: SecretRef holds the authentication secret for accessing
Expand Down
2 changes: 1 addition & 1 deletion docs/helmrelease-guide/automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ itself due to it having no knowledge of available images or the origin of the
`HelmRelease`.

For more details about this Flux feature, please refer to the [documentation
for the `HelmRelease` integration](https://docs.fluxcd.io/en/stable/references/helm-operator-integration.html).
for the `HelmRelease` integration](https://docs.fluxcd.io/en/stable/references/helm-operator-integration).

## Helm repository chart updates

Expand Down
8 changes: 4 additions & 4 deletions docs/references/helmrelease-custom-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -635,8 +635,8 @@ string
</td>
<td>
<p>Git URL is the URL of the Git repository, e.g.
[email protected]:org/repo, <a href="http://github.com/org/repo">http://github.com/org/repo</a>,
or ssh://[email protected]:2222/org/repo.git.</p>
<code>[email protected]:org/repo</code>, <code>http://github.com/org/repo</code>,
or <code>ssh://[email protected]:2222/org/repo.git</code>.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1381,8 +1381,8 @@ string
</td>
<td>
<p>RepoURL is the URL of the Helm repository, e.g.
<a href="https://kubernetes-charts.storage.googleapis.com">https://kubernetes-charts.storage.googleapis.com</a> or
<a href="https://charts.example.com">https://charts.example.com</a>.</p>
<code>https://kubernetes-charts.storage.googleapis.com</code> or
<code>https://charts.example.com</code>.</p>
</td>
</tr>
<tr>
Expand Down
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
mkdocs == 1.1
mkdocs-material == 4.6.3
mkdocs-material == 5.1.3
mkdocs-redirects
mkdocs-markdownextradata-plugin == 0.1.3
pymdown-extensions == 6.3.0
pymdown-extensions == 7.1
5 changes: 5 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ require (
github.com/bugsnag/panicwrap v1.2.0 // indirect
github.com/docker/go-metrics v0.0.1 // indirect
github.com/docker/libtrust v0.0.0-20160708172513-aabc10ec26b7 // indirect
github.com/fatih/color v1.9.0 // indirect
github.com/fluxcd/flux v1.17.2-0.20200121140732-3903cf8e71c3
github.com/fluxcd/helm-operator/pkg/install v0.0.0-00010101000000-000000000000
github.com/garyburd/redigo v1.6.0 // indirect
Expand All @@ -17,13 +18,17 @@ require (
github.com/google/go-cmp v0.4.0
github.com/gorilla/mux v1.7.3
github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 // indirect
github.com/kr/text v0.2.0 // indirect
github.com/mattn/go-colorable v0.1.6 // indirect
github.com/ncabatoff/go-seq v0.0.0-20180805175032-b08ef85ed833
github.com/pkg/errors v0.9.1
github.com/prometheus/client_golang v1.2.1
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.4.0
github.com/yvasiyarov/go-metrics v0.0.0-20150112132944-c25f46c4b940 // indirect
github.com/yvasiyarov/newrelic_platform_go v0.0.0-20160601141957-9c099fbc30e9 // indirect
golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e // indirect
golang.org/x/sys v0.0.0-20200327173247-9dae0f8f5775 // indirect
google.golang.org/grpc v1.27.0
helm.sh/helm/v3 v3.1.2
k8s.io/api v0.17.2
Expand Down
20 changes: 20 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ github.com/coreos/pkg v0.0.0-20160727233714-3ac0863d7acf/go.mod h1:E3G3o1h8I7cfc
github.com/coreos/pkg v0.0.0-20180108230652-97fdf19511ea/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA=
github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/cyphar/filepath-securejoin v0.2.2 h1:jCwT2GTP+PY5nBz3c/YL5PAIbusElVrPujOBSCj8xRg=
github.com/cyphar/filepath-securejoin v0.2.2/go.mod h1:FpkQEhXnPnOthhzymB7CGsFk2G9VLXONKD9G7QGMM+4=
github.com/davecgh/go-spew v0.0.0-20151105211317-5215b55f46b2/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
Expand Down Expand Up @@ -214,6 +215,8 @@ github.com/exponent-io/jsonpath v0.0.0-20151013193312-d6023ce2651d/go.mod h1:ZZM
github.com/fatih/camelcase v1.0.0/go.mod h1:yN2Sb0lFhZJUdVvtELVWefmrXpuZESvPmqwoZc+/fpc=
github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
github.com/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s=
github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU=
github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M=
github.com/fluxcd/flux v1.18.0 h1:LcUHmjfXr3omNHCh+8E+Pyc4Y0CRj1MS09779fEoTmQ=
github.com/fluxcd/flux v1.18.0/go.mod h1:pnv8ZZDFBir8Qk55+p+YGDbelSrwVe8FZrfMSfIc8gs=
Expand Down Expand Up @@ -466,6 +469,8 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/pty v1.1.5/go.mod h1:9r2w37qlBe7rQ6e1fg1S/9xpWHSnaqNdHD3WcMdbPDA=
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
github.com/lib/pq v1.2.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
github.com/liggitt/tabwriter v0.0.0-20181228230101-89fcab3d43de h1:9TO3cAIGXtEhnIaL+V+BEER86oLrvS+kWobKpbJuye0=
github.com/liggitt/tabwriter v0.0.0-20181228230101-89fcab3d43de/go.mod h1:zAbeS9B/r2mtpb6U+EI2rYA5OAXxsYw6wTamcNW+zcE=
Expand All @@ -484,11 +489,18 @@ github.com/mattn/go-colorable v0.1.0 h1:v2XXALHHh6zHfYTJ+cSkwtyffnaOyR1MXaA91mTr
github.com/mattn/go-colorable v0.1.0/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
github.com/mattn/go-colorable v0.1.2 h1:/bC9yWikZXAL9uJdulbSfyVNIR3n3trXl+v8+1sx8mU=
github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=
github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
github.com/mattn/go-colorable v0.1.6 h1:6Su7aK7lXmJ/U79bYtBjLNaha4Fs1Rg9plHpcH+vvnE=
github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
github.com/mattn/go-isatty v0.0.4 h1:bnP0vzxcAdeI1zdubAl5PjU6zsERjGZb7raWodagDYs=
github.com/mattn/go-isatty v0.0.4/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
github.com/mattn/go-isatty v0.0.8 h1:HLtExJ+uU2HOZ+wI0Tt5DtUDrx8yhUqDcp7fYERX4CE=
github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
github.com/mattn/go-isatty v0.0.11/go.mod h1:PhnuNfih5lzO57/f3n+odYbM4JtupLOxQOAqxQCu2WE=
github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
github.com/mattn/go-runewidth v0.0.2/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
github.com/mattn/go-runewidth v0.0.4 h1:2BvfKmzob6Bmd4YsL0zygOqfdFnK7GR4QL06Do4/p7Y=
github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
Expand Down Expand Up @@ -776,6 +788,8 @@ golang.org/x/net v0.0.0-20190813141303-74dc4d7220e7/go.mod h1:z5CRVTTTmAJ677TzLL
golang.org/x/net v0.0.0-20190827160401-ba9fcec4b297/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20191004110552-13f9640d40b9 h1:rjwSpXsdiK0dV8/Naq3kAw9ymfAeJIyd0upUIElB+lI=
golang.org/x/net v0.0.0-20191004110552-13f9640d40b9/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e h1:3G+cUijn7XD+S4eJFddp53Pv7+slrESplyjG25HgL+k=
golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45 h1:SVwTIAaPC2U/AvvLNZ2a7OVsmBpC8L5BlwK1whH3hm0=
Expand Down Expand Up @@ -819,8 +833,14 @@ golang.org/x/sys v0.0.0-20190801041406-cbf593c0f2f3/go.mod h1:h1NjWce9XRLGQEsW7w
golang.org/x/sys v0.0.0-20190826190057-c7b8b68b1456/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20191010194322-b09406accb47/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20191028164358-195ce5e7f934 h1:u/E0NqCIWRDAo9WCFo6Ko49njPFDLSd3z+X1HgWDMpE=
golang.org/x/sys v0.0.0-20191028164358-195ce5e7f934/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200327173247-9dae0f8f5775 h1:TC0v2RSO1u2kn1ZugjrFXkRZAEaqMN/RW+OTZkBzmLE=
golang.org/x/sys v0.0.0-20200327173247-9dae0f8f5775/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/text v0.0.0-20160726164857-2910a502d2bf/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.0.0-20180810153555-6e3c4e7365dd/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
Expand Down
8 changes: 3 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,14 @@ edit_uri: ""
extra:
version: 1.0.1
social:
- type: 'github'
link: 'https://github.com/fluxcd/helm-operator'
- icon: fontawesome/brands/github-alt
link: https://github.com/fluxcd/helm-operator

theme:
name: material
logo: _files/[email protected]
favicon: _files/[email protected]
language: en
feature:
tabs: false
palette:
primary: blue
accent: indigo
Expand All @@ -44,7 +42,7 @@ markdown_extensions:
guess_lang: false
- toc:
permalink: true
- pymdownx.superfences
- pymdownx.tabbed

nav:
- Overview: index.md
Expand Down
8 changes: 4 additions & 4 deletions pkg/apis/helm.fluxcd.io/v1/types_helmrelease.go
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,8 @@ type ChartSource struct {
// GitChartSource describes a Helm chart sourced from Git.
type GitChartSource struct {
// Git URL is the URL of the Git repository, e.g.
// [email protected]:org/repo, http://github.com/org/repo,
// or ssh://[email protected]:2222/org/repo.git.
// `[email protected]:org/repo`, `http://github.com/org/repo`,
// or `ssh://[email protected]:2222/org/repo.git`.
// +kubebuilder:validation:Optional
GitURL string `json:"git"`
// Ref is the Git branch (or other reference) to use. Defaults to
Expand Down Expand Up @@ -195,8 +195,8 @@ func (s GitChartSource) RefOrDefault(defaultGitRef string) string {
// repository.
type RepoChartSource struct {
// RepoURL is the URL of the Helm repository, e.g.
// https://kubernetes-charts.storage.googleapis.com or
// https://charts.example.com.
// `https://kubernetes-charts.storage.googleapis.com` or
// `https://charts.example.com`.
// +kubebuilder:validation:Optional
RepoURL string `json:"repository"`
// Name is the name of the Helm chart _without_ an alias, e.g.
Expand Down
Loading

0 comments on commit ba2c78e

Please sign in to comment.