docs: regenerated

jenkins-x-plugins · Jun 22, 2020 · 8184207 · 8184207
1 parent a310d6d
commit 8184207
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,25 @@ Download the [jx-alpha-promote binary](https://github.com/jenkins-x/jx-promote/r
 
 There will be an `app` you can install soon too...
 
-## Importing Repositories and Creating Quickstarts
+## Promoting via the command line
 
 Just run the `jx alpha promote` command line and follow the instructions as if it were `jx promote`.
+
+## Rules
+
+`jx promote` supports a number of different rules for promoting new versions of applications for various kinds of deployment tools.
+
+### Helm
+
+The helm rule uses a helm chart's `requirements.yaml` file to manage dependent applications. This is the traditional default source layout of a Jenkins X Staging or Production repository; there is usually a helm chart in the `env` folder and `jx-promote` will create a Pull Request adding or updating the applications version in `env/requirements.yaml`.
+
+You can [explicitly configure]() the helm rule by specifying the `helmRule` property on the [spec](https://github.com/jenkins-x/jx-promote/blob/master/docs/config.md#promote.jenkins-x.io/v1alpha1.PromoteSpec) of the [.jx/promote.yaml](https://github.com/jenkins-x/jx-promote/blob/master/docs/config.md#promote) configuration file. 
+
+
+## Rule Configuration
+
+You can configure which promotion rule is used declaratively in your environment git repository by creating a [.jx/promote.yaml](https://github.com/jenkins-x/jx-promote/blob/master/docs/config.md#promote) configuration file. 
+
+
+
+
diff --git a/docs/config.md b/docs/config.md
@@ -1,7 +1,7 @@
 ---
 title: API Documentation
 linktitle: API Documentation
-description: Reference of the Jenkins X REST APIs and custom resources
+description: Reference of the jx-promote configuration
 weight: 10
 ---
 <p>Packages:</p>
@@ -490,5 +490,5 @@ KptRule
 <hr/>
 <p><em>
 Generated with <code>gen-crd-api-reference-docs</code>
-on git commit <code>11f31d0</code>.
+on git commit <code>a310d6d</code>.
 </em></p>
diff --git a/hack/configdocs/templates/pkg.tpl b/hack/configdocs/templates/pkg.tpl
@@ -4,7 +4,7 @@
 ---
 title: API Documentation
 linktitle: API Documentation
-description: Reference of the Jenkins X REST APIs and custom resources
+description: Reference of the jx-promote configuration
 weight: 10
 ---