From ebbc1cf931669486a6e1977f33bb66803931d896 Mon Sep 17 00:00:00 2001 From: Christie Wilson Date: Fri, 25 Oct 2019 13:46:14 -0400 Subject: [PATCH] =?UTF-8?q?Make=20some=20docs=20a=20smidge=20more=20readab?= =?UTF-8?q?le=20=F0=9F=91=93?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Moved the links to the list of PipelineResources that we support further up in the doc so ppl casually glancing at it know its there, and ppl like me who refer to it all the time can get to it right away. Added some syntax highlighting around parameters in the install doc so they stand out from the surrounding text more. --- docs/install.md | 10 +++++----- docs/resources.md | 19 ++++++++----------- 2 files changed, 13 insertions(+), 16 deletions(-) diff --git a/docs/install.md b/docs/install.md index 28461e0937c..5f36009cc8d 100644 --- a/docs/install.md +++ b/docs/install.md @@ -124,20 +124,20 @@ or a [GCS storage bucket](https://cloud.google.com/storage/) The PVC option can be configured using a ConfigMap with the name `config-artifact-pvc` and the following attributes: -- size: the size of the volume (5Gi by default) -- storageClassName: the [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/) of the volume (default storage class by default). The possible values depend on the cluster configuration and the underlying infrastructure provider. +- `size`: the size of the volume (5Gi by default) +- `storageClassName`: the [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/) of the volume (default storage class by default). The possible values depend on the cluster configuration and the underlying infrastructure provider. The GCS storage bucket can be configured using a ConfigMap with the name `config-artifact-bucket` with the following attributes: -- location: the address of the bucket (for example gs://mybucket) +- `location`: the address of the bucket (for example gs://mybucket) - bucket.service.account.secret.name: the name of the secret that will contain the credentials for the service account with access to the bucket -- bucket.service.account.secret.key: the key in the secret with the required +- `bucket.service.account.secret.key`: the key in the secret with the required service account json. - The bucket is recommended to be configured with a retention policy after which files will be deleted. -- bucket.service.account.field.name: the name of the environment variable to use when specifying the +- `bucket.service.account.field.name`: the name of the environment variable to use when specifying the secret path. Defaults to `GOOGLE_APPLICATION_CREDENTIALS`. Set to `BOTO_CONFIG` if using S3 instead of GCS. Both options provide the same functionality to the pipeline. The choice is based diff --git a/docs/resources.md b/docs/resources.md index 756fd1ddb41..1fdca15f521 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -17,6 +17,14 @@ For example: - [Syntax](#syntax) - [Resource types](#resource-types) + - [Git Resource](#git-resource) + - [Pull Request Resource](#pull-request-resource) + - [Image Resource](#image-resource) + - [Cluster Resource](#cluster-resource) + - [Storage Resource](#storage-resource) + - [GCS Storage Resource](#gcs-storage-resource) + - [BuildGCS Storage Resource](#buildgcs-storage-resource) + - [Cloud Event Resource](#cloud-event-resource) - [Using Resources](#using-resources) ## Syntax @@ -211,17 +219,6 @@ resourcesResult: ## Resource Types -The following `PipelineResources` are currently supported: - -- [Git Resource](#git-resource) -- [Pull Request Resource](#pull-request-resource) -- [Image Resource](#image-resource) -- [Cluster Resource](#cluster-resource) -- [Storage Resource](#storage-resource) - - [GCS Storage Resource](#gcs-storage-resource) - - [BuildGCS Storage Resource](#buildgcs-storage-resource) -- [Cloud Event Resource](#cloud-event-resource) - ### Git Resource The `git` resource represents a [git](https://git-scm.com/) repository, that contains