Skip to content

Commit 69bf83a

Browse files
authored
Add config reference files for further contributions (#6544)
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
1 parent d374fa9 commit 69bf83a

File tree

3 files changed

+24
-4
lines changed

3 files changed

+24
-4
lines changed

docs/content/en/docs-v1.0.x/releases/_index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,7 @@ title: "Releases ⧉"
33
manualLink: "https://github.com/pipe-cd/pipecd/releases"
44
manualLinkTarget: "_blank"
55
weight: 99
6-
---
6+
---
7+
8+
>**Note:**
9+
>PipeCD v1 documentation is still a work in progress. We are updating this page. Check back soon. Happy PipeCDing!
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Configuration reference"
3+
linkTitle: "Configuration reference"
4+
weight: 9
5+
description: >
6+
Learn about all the configurable fields in the application configuration file.
7+
---
8+
9+
>**Note:**
10+
>PipeCD v1 documentation is still a work in progress. We are updating this configuration reference.
11+
> Until then, [see configurable fields for the application configuration file for v0.55](../../../docs-v0.55.x/user-guide/configuration-reference.md), and if you have any questions, [reach out to us](../../../../../../README.md#community-and-development) using one of our communication channels.
12+
>Happy PipeCDing!

docs/content/en/docs-v1.0.x/user-guide/managing-piped/configuration-reference.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,15 @@ title: "Configuration reference"
33
linkTitle: "Configuration reference"
44
weight: 9
55
description: >
6-
This page describes all configurable fields in the piped configuration.
6+
Learn about all the configurable fields in the `piped` configuration file.
77
---
88

9-
``` yaml
9+
>**Note:**
10+
>PipeCD v1 documentation is still a work in progress. We are updating this configuration reference.
11+
> Until then, [see configurable fields for the piped configuration file for v0.55](../../../docs-v0.55.x/user-guide/managing-piped/configuration-reference.md), and if you have any questions, [reach out to us](../../../../../../README.md#community-and-development) using one of our communication channels.
12+
>Happy PipeCDing!
13+
14+
<!-- ``` yaml
1015
apiVersion: pipecd.dev/v1beta1
1116
kind: Piped
1217
spec:
@@ -270,4 +275,4 @@ Must be one of the following structs:
270275
| url | string | The URL where notification event will be sent to. | Yes |
271276
| signatureKey | string | The HTTP header key used to store the configured signature in each event. Default is "PipeCD-Signature". | No |
272277
| signatureValue | string | The value of signature included in header of each event request. It can be used to verify the received events. | No |
273-
| signatureValueFile | string | The path to the signature value file. | No |
278+
| signatureValueFile | string | The path to the signature value file. | No | -->

0 commit comments

Comments
 (0)