Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] a couple typos #12354

Open
SJrX opened this issue Feb 8, 2023 · 1 comment
Open

[doc] a couple typos #12354

SJrX opened this issue Feb 8, 2023 · 1 comment
Labels
bug Something isn't working documentation Issue is related to missing or incorrect documentation

Comments

@SJrX
Copy link
Contributor

SJrX commented Feb 8, 2023

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:

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

successfully is spelt wrong here:

message: The app {{ .app.metadata.name }} has succesfully synced!

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 
@SJrX SJrX added the bug Something isn't working label Feb 8, 2023
@keithchong keithchong added the documentation Issue is related to missing or incorrect documentation label Feb 11, 2023
@martin-nolan-2020
Copy link

I'll work on this and submit a PR later

sayefiqb added a commit to sayefiqb/argo-cd that referenced this issue May 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Issue is related to missing or incorrect documentation
Projects
None yet
Development

No branches or pull requests

3 participants