argoproj / argo-cd

Declarative Continuous Deployment for Kubernetes
https://argo-cd.readthedocs.io
Apache License 2.0
17.72k stars 5.4k forks source link

[doc] a couple typos #12354

Open SJrX opened 1 year ago

SJrX commented 1 year ago

There are a couple of typos in the documentation, I submitted an MR to fix them #12280 however something with the auto generation checks prevented them from being fixed, so I gave up and reverted those two changes.

Notification is spelt wrong here: https://github.com/argoproj/argo-cd/blob/17167fc2e7e28a5b25151c8a269ea17477038aba/docs/operator-manual/notifications/services/teams.md?plain=1#L116

successfully is spelt wrong here: https://github.com/argoproj/argo-cd/blob/17167fc2e7e28a5b25151c8a269ea17477038aba/docs/operator-manual/notifications/services/googlechat.md?plain=1#L89

When I tried to fix it in my branch the Check nothing has changed failed.

Running make codegen just reverted the changes.

tee codegen.patch
+ git diff --exit-code -- . ':!go.sum' ':!go.mod' ':!assets/swagger.json'
diff --git a/docs/operator-manual/notifications/services/googlechat.md b/docs/operator-manual/notifications/services/googlechat.md
index c1ca0d5..041ea6e 100755
--- a/docs/operator-manual/notifications/services/googlechat.md
+++ b/docs/operator-manual/notifications/services/googlechat.md
@@ -[8](https://github.com/argoproj/argo-cd/actions/runs/4085098586/jobs/7042616267#step:10:9)6,7 +86,7 @@ It is possible send both simple text and card messages in a chat thread by speci

 ```yaml
 template.app-sync-succeeded: |
-  message: The app {{ .app.metadata.name }} has successfully synced!
+  message: The app {{ .app.metadata.name }} has succesfully synced!
   googlechat:
     threadKey: {{ .app.metadata.name }}

diff --git a/docs/operator-manual/notifications/services/teams.md b/docs/operator-manual/notifications/services/teams.md index fc291c4..eb50f55 100755 --- a/docs/operator-manual/notifications/services/teams.md +++ b/docs/operator-manual/notifications/services/teams.md @@ -113,7 +113,7 @@ template.app-sync-succeeded: |

summary field

-You can set a summary of the message that will be shown on Notification & Activity Feed +You can set a summary of the message that will be shown on Notifcation & Activity Feed

@@ -123,4 +123,4 @@ You can set a summary of the message that will be shown on Notification & Activi template.app-sync-succeeded: | teams: summary: "Sync Succeeded" - +



I gave up at that point, https://github.com/argoproj/argo-cd/actions/runs/4085098586/jobs/7042616267 
martin-nolan-2020 commented 1 year ago

I'll work on this and submit a PR later