public_git
/
helmfile
mirror of https://github.com/helmfile/helmfile.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #217 from helmfile/fix_doc 

Fix doc link error and style error
This commit is contained in:
yxxhero 2022-07-12 07:33:46 +08:00 committed by GitHub
parent 65fae9c52c f0662f2ebe
commit 008f4906aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -7,12 +7,12 @@
"MD041": false "MD041": false
} --> } -->
<div align="center"> <div align="center" markdown="1">
# Helmfile # Helmfile
[![Tests](https://github.com/helmfile/helmfile/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/helmfile/helmfile/actions/workflows/ci.yaml?query=branch%3Amain) [![Tests](https://github.com/helmfile/helmfile/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/helmfile/helmfile/actions/workflows/ci.yaml?query=branch%3Amain)
[![Docker Repository on Quay](https://quay.io/repository/roboll/helmfile/status "Docker Repository on Quay")](https://quay.io/repository/roboll/helmfile) [![Docker Repository on Quay](https://quay.io/repository/roboll/helmfile/status "Docker Repository on Quay")](https://github.com/helmfile/helmfile/pkgs/container/helmfile)
[![Slack Community #helmfile](https://slack.sweetops.com/badge.svg)](https://slack.sweetops.com) [![Slack Community #helmfile](https://slack.sweetops.com/badge.svg)](https://slack.sweetops.com)
[![Documentation](https://readthedocs.org/projects/helmfile/badge/?version=latest&style=flat)](https://helmfile.readthedocs.io/en/latest/) [![Documentation](https://readthedocs.org/projects/helmfile/badge/?version=latest&style=flat)](https://helmfile.readthedocs.io/en/latest/)
@ -25,7 +25,7 @@ Deploy Kubernetes Helm Charts
March 2022 Update - The helmfile project has been moved to [helmfile/helmfile](https://github.com/helmfile/helmfile) from the former home `roboll/helmfile`. Please see roboll/helmfile#1824 for more information. March 2022 Update - The helmfile project has been moved to [helmfile/helmfile](https://github.com/helmfile/helmfile) from the former home `roboll/helmfile`. Please see roboll/helmfile#1824 for more information.
Even though Helmfile is used in production environments [across multiple organizations](USERS.md), it is still in its early stage of development, hence versioned 0.x. Even though Helmfile is used in production environments [across multiple organizations](users.md), it is still in its early stage of development, hence versioned 0.x.
Helmfile complies to Semantic Versioning 2.0.0 in which v0.x means that there could be backward-incompatible changes for every release. Helmfile complies to Semantic Versioning 2.0.0 in which v0.x means that there could be backward-incompatible changes for every release.
@ -375,7 +375,7 @@ We also added the following functions:
- `fetchSecretValue` - `fetchSecretValue`
- `expandSecretRefs` - `expandSecretRefs`
More details on each function can be found at ["Template Functions" page in our documentation](./docs/templating_funcs.md). More details on each function can be found at ["Template Functions" page in our documentation](templating_funcs.md).
## Using environment variables ## Using environment variables
@ -617,7 +617,7 @@ A few rules to clear up this ambiguity:
- Relative paths referenced *in* the Helmfile manifest itself are relative to that manifest - Relative paths referenced *in* the Helmfile manifest itself are relative to that manifest
- Relative paths referenced on the command line are relative to the current working directory the user is in - Relative paths referenced on the command line are relative to the current working directory the user is in
For additional context, take a look at [paths examples](PATHS.md). For additional context, take a look at [paths examples](docs/paths.md).
## Labels Overview ## Labels Overview

2
docs/paths.md
View File

@ -10,7 +10,7 @@ A few rules to clear up this ambiguity:
### Examples ### Examples
There are several examples that we can go through in the [`/examples`](examples) folder which demonstrate this. There are several examples that we can go through in the [`/examples`](../examples/) folder which demonstrate this.
**Local Execution** **Local Execution**

1
mkdocs.yml
View File

@ -17,6 +17,7 @@ nav:
- Home: index.md - Home: index.md
- Getting Started: - Getting Started:
- Paths Overview: paths.md - Paths Overview: paths.md
- Templating Funs: templating_funcs.md
- Advanced Features: - Advanced Features:
- Best Practices Guide: writing-helmfile.md - Best Practices Guide: writing-helmfile.md
- Advanced Features: advanced-features.md - Advanced Features: advanced-features.md