Skip to content

Commit a3fa0e0

Browse files
Fix typos and heading level in piped configuration docs (#6725)
Signed-off-by: harshitghagre <harshitghagre183@gmail.com>
1 parent 60d7269 commit a3fa0e0

3 files changed

Lines changed: 11 additions & 11 deletions

File tree

docs/content/en/docs-dev/user-guide/managing-piped/configuration-reference.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ Must be one of the following structs:
201201
| Field | Type | Description | Required |
202202
|-|-|-|-|
203203
| type | string | Which management method should be used. Default is `KEY_PAIR`. | Yes |
204-
| config | [SecretManagementConfig](#secretmanagementconfig) | Configration for using secret management method. | Yes |
204+
| config | [SecretManagementConfig](#secretmanagementconfig) | Configuration for using secret management method. | Yes |
205205

206206
## SecretManagementConfig
207207

@@ -248,7 +248,7 @@ Must be one of the following structs:
248248
| Field | Type | Description | Required |
249249
|-|-|-|-|
250250
| name | string | The name of the receiver. | Yes |
251-
| slack | [NotificationReciverSlack](#notificationreceiverslack) | Configuration for slack receiver. | No |
251+
| slack | [NotificationReceiverSlack](#notificationreceiverslack) | Configuration for slack receiver. | No |
252252
| webhook | [NotificationReceiverWebhook](#notificationreceiverwebhook) | Configuration for webhook receiver. | No |
253253

254254
#### NotificationReceiverSlack
@@ -258,10 +258,10 @@ Must be one of the following structs:
258258
| hookURL | string | The hookURL of a slack channel. | Yes |
259259
| oauthToken | string | [The token for Slack API use.](https://api.slack.com/authentication/basics) (deprecated)| No |
260260
| oauthTokenData | string | Base64 encoded string of [The token for Slack API use.](https://api.slack.com/authentication/basics) | No |
261-
| oauthTokenFile | string | The path to the oautoken file | No |
261+
| oauthTokenFile | string | The path to the oauthToken file | No |
262262
| channelID | string | The channel id which slack api send to. | No |
263-
| mentionedAccounts | []string | The accounts to which slack api referes. This field supports both `@username` and `username` writing styles.| No |
264-
| mentionedGroups | []string | The groups to which slack api referes. This field supports both `<!subteam^groupname>` and `groupname` writing styles.| No |
263+
| mentionedAccounts | []string | The accounts to which slack api refers. This field supports both `@username` and `username` writing styles.| No |
264+
| mentionedGroups | []string | The groups to which slack api refers. This field supports both `<!subteam^groupname>` and `groupname` writing styles.| No |
265265

266266
#### NotificationReceiverWebhook
267267

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ Must be one of the following structs:
206206
| Field | Type | Description | Required |
207207
|-|-|-|-|
208208
| type | string | Which management method should be used. Default is `KEY_PAIR`. | Yes |
209-
| config | [SecretManagementConfig](#secretmanagementconfig) | Configration for using secret management method. | Yes |
209+
| config | [SecretManagementConfig](#secretmanagementconfig) | Configuration for using secret management method. | Yes |
210210
211211
## SecretManagementConfig
212212
@@ -253,7 +253,7 @@ Must be one of the following structs:
253253
| Field | Type | Description | Required |
254254
|-|-|-|-|
255255
| name | string | The name of the receiver. | Yes |
256-
| slack | [NotificationReciverSlack](#notificationreceiverslack) | Configuration for slack receiver. | No |
256+
| slack | [NotificationReceiverSlack](#notificationreceiverslack) | Configuration for slack receiver. | No |
257257
| webhook | [NotificationReceiverWebhook](#notificationreceiverwebhook) | Configuration for webhook receiver. | No |
258258
259259
#### NotificationReceiverSlack
@@ -263,10 +263,10 @@ Must be one of the following structs:
263263
| hookURL | string | The hookURL of a slack channel. | Yes |
264264
| oauthToken | string | [The token for Slack API use.](https://api.slack.com/authentication/basics) (deprecated)| No |
265265
| oauthTokenData | string | Base64 encoded string of [The token for Slack API use.](https://api.slack.com/authentication/basics) | No |
266-
| oauthTokenFile | string | The path to the oautoken file | No |
266+
| oauthTokenFile | string | The path to the oauthToken file | No |
267267
| channelID | string | The channel id which slack api send to. | No |
268-
| mentionedAccounts | []string | The accounts to which slack api referes. This field supports both `@username` and `username` writing styles.| No |
269-
| mentionedGroups | []string | The groups to which slack api referes. This field supports both `<!subteam^groupname>` and `groupname` writing styles.| No |
268+
| mentionedAccounts | []string | The accounts to which slack api refers. This field supports both `@username` and `username` writing styles.| No |
269+
| mentionedGroups | []string | The groups to which slack api refers. This field supports both `<!subteam^groupname>` and `groupname` writing styles.| No |
270270
271271
#### NotificationReceiverWebhook
272272

docs/content/en/docs-v1.0.x/user-guide/managing-piped/configuring-a-plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ spec:
7474

7575
See [Configuration Reference for Kubernetes plugin](../configuration-reference/#kubernetesplugin) for complete configuration details.
7676

77-
### Configuring Terraform plugin
77+
## Configuring Terraform plugin
7878

7979
The Terraform plugin enables Piped to run Terraform-based deployments.
8080
A deploy target represents a Terraform execution environment (e.g., dev/prod workspace, shared variables, drift detection settings).

0 commit comments

Comments
 (0)