diff --git a/.circleci/config.yml b/.circleci/config.yml index 8e4434cc5..1a063a354 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -102,7 +102,6 @@ jobs: - run: make check-generated - run: make all - run: E2E_KIND_CLUSTER_NUM=4 make e2e - - run: make test-docs - save_cache: key: cache-{{ checksum "Makefile" }} paths: diff --git a/.github/workflows/check-links.yaml b/.github/workflows/check-links.yaml new file mode 100644 index 000000000..5638aaf2f --- /dev/null +++ b/.github/workflows/check-links.yaml @@ -0,0 +1,27 @@ +on: [push, pull_request] +name: Check links +jobs: + linkChecker: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [3.8] + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v1 + with: + 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 + id: lc + uses: peter-evans/link-checker@v1 + with: + args: -r -d site/ -v site/index.html + - name: Fail if there were link errors + run: exit ${{ steps.lc.outputs.exit_code }} diff --git a/.gitignore b/.gitignore index 74ce3b019..fc17ae43b 100644 --- a/.gitignore +++ b/.gitignore @@ -50,4 +50,4 @@ test/bin/ test/e2e/bats # Docs -docs/_build +site/ diff --git a/.readthedocs.yml b/.readthedocs.yml index a36db8a13..d99cf58b2 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,13 +5,9 @@ # Required version: 2 -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/conf.py - # Build documentation with MkDocs -#mkdocs: -# configuration: mkdocs.yml +mkdocs: + configuration: mkdocs.yml # Optionally build your docs in additional formats such as PDF and ePub formats: all diff --git a/Makefile b/Makefile index 3e3684c0c..76771393a 100644 --- a/Makefile +++ b/Makefile @@ -35,8 +35,6 @@ IMAGE_TAG:=$(shell ./docker/image-tag) VCS_REF:=$(shell git rev-parse HEAD) BUILD_DATE:=$(shell date -u +'%Y-%m-%dT%H:%M:%SZ') -DOCS_PORT:=8000 - GENERATED_TEMPLATES_FILE=pkg/install/generated_templates.gogen.go all: $(GOBIN)/fluxctl $(GOBIN)/fluxd build/.flux.done @@ -187,12 +185,8 @@ build-fluxctl: release-bins --build-arg BUILD_DATE="$(BUILD_DATE)" \ -f ./build/docker/fluxctl/Dockerfile ./build/docker/fluxctl -build-docs: - @cd docs && docker build -t flux-docs . - -test-docs: build-docs - @docker run -it flux-docs /usr/bin/linkchecker _build/html/index.html +docs-deps: + pip3 install -r docs/requirements.txt -serve-docs: build-docs - @echo Stating docs website on http://localhost:${DOCS_PORT}/_build/html/index.html - @docker run -i -p ${DOCS_PORT}:8000 -e USER_ID=$$UID flux-docs +serve-docs: docs-deps + mkdocs serve diff --git a/README.md b/README.md index 3b4d6d953..18864d115 100644 --- a/README.md +++ b/README.md @@ -81,8 +81,8 @@ could easily integrate. With the following tutorials: -- [Get started with Flux](https://docs.fluxcd.io/en/latest/tutorials/get-started.html) -- [Get started with Flux using Helm](https://docs.fluxcd.io/en/latest/tutorials/get-started-helm.html) +- [Get started with Flux](https://docs.fluxcd.io/en/latest/tutorials/get-started) +- [Get started with Flux using Helm](https://docs.fluxcd.io/en/latest/tutorials/get-started-helm) or just [browse through the documentation](https://docs.fluxcd.io). @@ -116,7 +116,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/latest/contributing/building.html) +- [Build documentation](https://docs.fluxcd.io/en/latest/contributing/building) - [Release documentation](/internal_docs/releasing.md) ## Getting Help diff --git a/chart/flux/CHANGELOG.md b/chart/flux/CHANGELOG.md index 5db4d9de8..e8670def4 100644 --- a/chart/flux/CHANGELOG.md +++ b/chart/flux/CHANGELOG.md @@ -31,7 +31,7 @@ Please see the [install instruction](https://github.com/fluxcd/helm-operator/tre for Helm Operator v1.0.0. To keep using the same SSH key as Flux see the docs [here](https://github.com/fluxcd/helm-operator/tree/master/chart/helm-operator#use-fluxs-git-deploy-key). The upgrade procedure for `HelmReleases` from `v1beta1` to `v1` can be found -[here](https://docs.fluxcd.io/projects/helm-operator/en/latest/guides/upgrading-to-ga.html). +[here](https://docs.fluxcd.io/projects/helm-operator/en/latest/how-to/upgrade-to-ga/). ### Improvements @@ -65,7 +65,7 @@ Please see the [install instruction](https://github.com/fluxcd/helm-operator/tre for Helm Operator v1.0.0. To keep using the same SSH key as Flux see the docs [here](https://github.com/fluxcd/helm-operator/tree/master/chart/helm-operator#use-fluxs-git-deploy-key). The upgrade procedure for `HelmReleases` from `v1beta1` to `v1` can be found -[here](https://docs.fluxcd.io/projects/helm-operator/en/latest/guides/upgrading-to-ga.html). +[here](https://docs.fluxcd.io/projects/helm-operator/en/latest/how-to/upgrade-to-ga/). ### Improvements diff --git a/chart/flux/templates/NOTES.txt b/chart/flux/templates/NOTES.txt index 1ac035c49..6b9f607b8 100644 --- a/chart/flux/templates/NOTES.txt +++ b/chart/flux/templates/NOTES.txt @@ -3,7 +3,7 @@ Get the Git deploy key by either (a) running kubectl -n {{ .Release.Namespace }} logs deployment/{{ .Release.Name }} | grep identity.pub | cut -d '"' -f2 or by (b) installing fluxctl through -https://docs.fluxcd.io/en/latest/references/fluxctl.html#installing-fluxctl +https://docs.fluxcd.io/en/latest/references/fluxctl#installing-fluxctl and running: fluxctl identity --k8s-fwd-ns {{ .Release.Namespace }} diff --git a/deploy/flux-deployment.yaml b/deploy/flux-deployment.yaml index 98defa5c2..10d87d512 100644 --- a/deploy/flux-deployment.yaml +++ b/deploy/flux-deployment.yaml @@ -38,7 +38,7 @@ spec: # file, which you will need to do if you host your own git # repo rather than using github or the like. You'll also need to # mount it into the container, below. See - # https://docs.fluxcd.io/en/latest/guides/use-private-git-host.html + # https://docs.fluxcd.io/en/latest/guides/use-private-git-host # - name: ssh-config # configMap: # name: flux-ssh-config diff --git a/docs/Dockerfile b/docs/Dockerfile deleted file mode 100644 index dab83daaa..000000000 --- a/docs/Dockerfile +++ /dev/null @@ -1,17 +0,0 @@ -FROM ddidier/sphinx-doc - -COPY requirements.txt . - -RUN apt update && apt install -y linkchecker && \ - pip install -r requirements.txt - -WORKDIR /doc - -COPY . . - -RUN make html && \ - cd /doc/_build/html/_static/fonts/RobotoSlab && \ - ln -s roboto-slab-v7-regular.eot roboto-slab.eot - -CMD ["python", "-m", "http.server", "8000"] - diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 51285967a..000000000 --- a/docs/Makefile +++ /dev/null @@ -1,19 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index faa300bc1..0c7edb7a6 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,15 +1,24 @@ @import url("https://fonts.googleapis.com/css?family=Montserrat&display=swap"); -@import url("https://fonts.googleapis.com/css?family=Roboto+Mono&display=swap"); body { font-family: "Montserrat", sans-serif; } -.rst-content pre.literal-block, .rst-content div[class^="highlight"] pre, .rst-content .linenodiv pre { - font-family: "Roboto Mono", monospace; +.md-logo { + width: 40px; + height: 40px; + padding-bottom: 2px; + padding-top: 2px; +} +.md-logo img { + width: 40px; + height: 40px; } -code { - font-family: "Roboto Mono", monospace; +.md-header, .md-footer-nav { + background-image: linear-gradient(45deg, rgb(0, 150, 225) 0%, rgb(27, 141, 226) 24%, rgb(42, 125, 227) 53%, rgb(53, 112, 227) 78%, rgb(53, 112, 227) 100%); } +.md-header-nav__title { + font-size: .85rem; +} diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 5cdda0853..000000000 --- a/docs/conf.py +++ /dev/null @@ -1,177 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Configuration file for the Sphinx documentation builder. -# -# This file does only contain a selection of the most common options. For a -# full list see the documentation: -# http://www.sphinx-doc.org/en/master/config - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import sys -sys.path.insert(0, os.path.abspath('.')) - -# -- Project information ----------------------------------------------------- - -project = 'Flux' -copyright = '2019, Flux development team' -author = 'Flux development team' - -# The short X.Y version -version = '' -# The full version, including alpha/beta/rc tags -release = '' - - -# -- General configuration --------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'recommonmark', - 'sphinx_markdown_tables', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -source_suffix = ['.rst', '.md'] - -# The master toctree document. -master_doc = 'index' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'sphinx_rtd_theme' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# The default sidebars (for documents that don't match any pattern) are -# defined by theme itself. Builtin themes are using these templates by -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', -# 'searchbox.html']``. -# -# html_sidebars = {} - - -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Fluxdoc' - - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'Flux.tex', 'Flux Documentation', - 'Flux development team', 'manual'), -] - - -# -- Options for manual page output ------------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'flux', 'Flux Documentation', - [author], 1) -] - - -# -- Options for Texinfo output ---------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'Flux', 'Flux Documentation', - author, 'Flux', 'One line description of project.', - 'Miscellaneous'), -] - - -# -- Options for Epub output ------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -# -# epub_identifier = '' - -# A unique identification for the text. -# -# epub_uid = '' - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - -def setup(app): - app.add_stylesheet('custom.css') diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst deleted file mode 100644 index a4f190e3b..000000000 --- a/docs/contributing/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Contributing -============ - -.. toctree:: - :maxdepth: 1 - - get-started-developing - building diff --git a/docs/get-started/index.md b/docs/get-started/index.md new file mode 100644 index 000000000..d0225722c --- /dev/null +++ b/docs/get-started/index.md @@ -0,0 +1,14 @@ +# Get started + +All you need is a Kubernetes cluster and a git repo. The git repo +contains [manifests](https://kubernetes.io/docs/concepts/configuration/overview/) +(as YAML files) describing what should run in the cluster. Flux imposes +[some requirements](../requirements.md) on these files. + +## Installing Flux + +Here are the instructions to [install Flux on your own +cluster](../tutorials/get-started). + +If you are using Helm, we have a [separate section about +this](../tutorials/get-started-helm). diff --git a/docs/get-started/index.rst b/docs/get-started/index.rst deleted file mode 100644 index 4de102604..000000000 --- a/docs/get-started/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Get started -=========== - -All you need is a Kubernetes cluster and a git repo. The git repo -contains `manifests `_ -(as YAML files) describing what should run in the cluster. Flux imposes -:doc:`some requirements <../requirements>` on these files. - -Installing Flux ---------------- - -Here are the instructions to :doc:`install Flux on your own -cluster <../tutorials/get-started>`. - -If you are using Helm, we have a :doc:`separate section about -this <../tutorials/get-started-helm>`. diff --git a/docs/guides/index.rst b/docs/guides/index.rst deleted file mode 100644 index 2121da5d7..000000000 --- a/docs/guides/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Guides -====== - -.. toctree:: - :maxdepth: 1 - - provide-own-ssh-key - use-git-https - use-private-git-host - upgrading-to-1.0 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..856e2309c --- /dev/null +++ b/docs/index.md @@ -0,0 +1,46 @@ +# Welcome to the Flux documentation! + +![](_files/flux-cd-diagram.png) + +## Flux + +- [Introducing Flux](introduction.md) +- [Requirements and limitations](requirements.md) +- [Get Started](get-started/index.md) +- [Frequently asked questions](faq.md) +- [Troubleshooting](troubleshooting.md) + +### References + +- [Blueprint](references/blueprint.md) +- [Daemon (fluxd)](references/daemon.md) +- [fluxctl](references/fluxctl.md) +- [Manifest generation through `.flux.yaml` configuration files](references/fluxyaml-config-files.md) +- [Garbage collection](references/garbagecollection.md) +- [Git commit signing and verification](references/git-gpg.md) +- [Automated deployment of new container images](references/automated-image-update.md) +- [Integration with the Helm operator](references/helm-operator-integration.md) +- [Monitoring Flux](references/monitoring.md) + +### Guides + +- [Providing your own SSH key](guides/provide-own-ssh-key.md) +- [Using Git over HTTPS](guides/use-git-https.md) +- [Using a private Git host](guides/use-private-git-host.md) +- [Upgrading to Flux v1](guides/upgrading-to-1.0.md) + +### Tutorials + +- [Get started](tutorials/get-started.md) +- [Get started using Helm](tutorials/get-started-helm.md) +- [How to bootstrap Flux using Kustomize](tutorials/get-started-kustomize.md) +- [Automations, locks and annotations](tutorials/driving-flux.md) + +## Helm Operator + +- [Documentation](https://docs.fluxcd.io/projects/helm-operator/) + +## Contributing + +- [Get started developing](contributing/get-started-developing.md) +- [Building Flux](contributing/building.md) diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 8d52e960e..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to the Flux documentation! -================================== - -.. image:: _files/flux-icon@2x.png - -.. toctree:: - :maxdepth: 2 - :caption: Flux - - introduction - requirements - get-started/index - - references/index - guides/index - tutorials/index - - faq - troubleshooting - -.. toctree:: - :caption: Helm Operator - - Documentation - -.. toctree:: - :maxdepth: 2 - :caption: Contributing - - contributing/index diff --git a/docs/references/fluxctl.md b/docs/references/fluxctl.md index 68e3efdca..3c7b0c7fc 100644 --- a/docs/references/fluxctl.md +++ b/docs/references/fluxctl.md @@ -242,7 +242,7 @@ Example: fluxctl install --git-url 'git@github.com:/flux-get-started' | kubectl -f - ``` -See [here](../tutorials/get-started.html#set-up-flux) for a full tutorial which makes use of `fluxctl install`. +See [here](../tutorials/get-started.md#set-up-flux) for a full tutorial which makes use of `fluxctl install`. ## Workloads diff --git a/docs/references/index.rst b/docs/references/index.rst deleted file mode 100644 index ebba27d58..000000000 --- a/docs/references/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -References -========== - -.. toctree:: - :maxdepth: 1 - - blueprint - daemon - fluxctl - fluxyaml-config-files - garbagecollection - git-gpg - automated-image-update - helm-operator-integration - monitoring diff --git a/docs/requirements.txt b/docs/requirements.txt index 8d8c8b388..38905eb4e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ -sphinx == 2.3.0 -sphinx_markdown_tables == 0.0.10 -recommonmark == 0.6.0 +mkdocs == 1.1 +mkdocs-material == 4.6.3 +mkdocs-redirects +pymdown-extensions == 6.3.0 diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst deleted file mode 100644 index e59971045..000000000 --- a/docs/tutorials/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Tutorials -========= - -.. toctree:: - :maxdepth: 1 - - get-started - get-started-helm - get-started-kustomize - driving-flux diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..7922279c1 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,69 @@ +site_name: Flux +site_description: Documentation for Flux, the GitOps Kubernetes operator. +site_author: The Flux contributors +site_url: https://docs.fluxcd.io/ + +# Repository +repo_name: fluxcd/flux +repo_url: https://github.com/fluxcd/flux +edit_uri: "" + +theme: + name: material + logo: _files/flux-icon@2x.png + language: en + feature: + tabs: false + palette: + primary: blue + accent: indigo + +docs_dir: docs + +extra_css: + - _static/custom.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 + +nav: + - Introducing Flux: introduction.md + - Requirements and limitations: requirements.md + - Get Started: get-started/index.md + - References: + - Blueprint: references/blueprint.md + - Daemon (fluxd): references/daemon.md + - fluxctl: references/fluxctl.md + - Manifest generation through .flux.yaml configuration files: references/fluxyaml-config-files.md + - Garbage collection: references/garbagecollection.md + - Git commit signing and verification: references/git-gpg.md + - Automated deployment of new container images: references/automated-image-update.md + - Integration with the Helm operator: references/helm-operator-integration.md + - Monitoring Flux: references/monitoring.md + - Guides: + - Providing your own SSH key: guides/provide-own-ssh-key.md + - Using Git over HTTPS: guides/use-git-https.md + - Using a private Git host: guides/use-private-git-host.md + - Upgrading to Flux v1: guides/upgrading-to-1.0.md + - Tutorials: + - Get started: tutorials/get-started.md + - Get started using Helm: tutorials/get-started-helm.md + - How to bootstrap Flux using Kustomize: tutorials/get-started-kustomize.md + - Automations, locks and annotations: tutorials/driving-flux.md + - Frequently asked questions: faq.md + - Troubleshooting: troubleshooting.md + - Contributing: + - Get started developing: contributing/get-started-developing.md + - Building Flux: contributing/building.md diff --git a/pkg/daemon/errors.go b/pkg/daemon/errors.go index 4883555c1..ee6b2478a 100644 --- a/pkg/daemon/errors.go +++ b/pkg/daemon/errors.go @@ -28,7 +28,7 @@ giving this error: Check that any files mentioned are well-formed, and resources are not defined more than once. It's also worth reviewing - https://docs.fluxcd.io/en/latest/requirements.html + https://docs.fluxcd.io/en/latest/requirements to make sure you're not running into any corner cases. diff --git a/pkg/git/errors.go b/pkg/git/errors.go index 4feb16119..c8e09050e 100644 --- a/pkg/git/errors.go +++ b/pkg/git/errors.go @@ -16,7 +16,7 @@ We need to clone a git repo to proceed, and you haven't supplied one. Please upload a config file, including a git repository URL, as described in - https://docs.fluxcd.io/en/latest/references/fluxctl.html + https://docs.fluxcd.io/en/latest/references/fluxctl `, } diff --git a/pkg/install/templates/flux-deployment.yaml.tmpl b/pkg/install/templates/flux-deployment.yaml.tmpl index 3873e69a6..a2e8f37c2 100644 --- a/pkg/install/templates/flux-deployment.yaml.tmpl +++ b/pkg/install/templates/flux-deployment.yaml.tmpl @@ -38,7 +38,7 @@ spec: # file, which you will need to do if you host your own git # repo rather than using github or the like. You'll also need to # mount it into the container, below. See - # https://docs.fluxcd.io/en/latest/guides/use-private-git-host.html + # https://docs.fluxcd.io/en/latest/guides/use-private-git-host # - name: ssh-config # configMap: # name: flux-ssh-config diff --git a/pkg/release/errors.go b/pkg/release/errors.go index 28b36d62d..b45050d7e 100644 --- a/pkg/release/errors.go +++ b/pkg/release/errors.go @@ -14,7 +14,7 @@ func MakeReleaseError(err error) *fluxerr.Error { This may be because of a limitation in the formats of file Flux can deal with. See - https://docs.fluxcd.io/en/latest/requirements.html + https://docs.fluxcd.io/en/latest/requirements for those limitations.