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

docs: fixes the YAML codefence for Slack notification service #8776 #8777

Merged
merged 3 commits into from
Mar 23, 2022
Merged

docs: fixes the YAML codefence for Slack notification service #8776 #8777

merged 3 commits into from
Mar 23, 2022

Conversation

omBratteng
Copy link
Contributor

@omBratteng omBratteng commented Mar 14, 2022

Signed-off-by: Ole-Martin Bratteng 1681525+omBratteng@users.noreply.github.com

Fixes [#8776]

Note on DCO:

If the DCO action in the integration test fails, one or more of your commits are not signed off. Please click on the Details link next to the DCO action for instructions on how to resolve this.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • Optional. My organization is added to USERS.md.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).

Comment on lines +32 to +37
apiVersion: v1
kind: Secret
metadata:
name: <secret-name>
stringData:
slack-token: <Oauth-access-token>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These have to be in the indented format, as using ```yaml removes the numbering of the ordered list.
image

@codecov
Copy link

codecov bot commented Mar 14, 2022

Codecov Report

Merging #8777 (9919504) into master (8b17abc) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #8777   +/-   ##
=======================================
  Coverage   42.85%   42.85%           
=======================================
  Files         186      186           
  Lines       23359    23359           
=======================================
  Hits        10011    10011           
  Misses      11914    11914           
  Partials     1434     1434           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8b17abc...9919504. Read the comment docs.

Copy link
Contributor

@rishabh625 rishabh625 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@omBratteng
Copy link
Contributor Author

Noticed that the docs are copied from https://github.com/argoproj/notifications-engine, so I've created a PR there to update the YAML.

Copy link
Member

@pasha-codefresh pasha-codefresh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pasha-codefresh
Copy link
Member

@omBratteng could you please fix pr checks?

@omBratteng
Copy link
Contributor Author

@pasha-codefresh the PR checks that are failing, are because the step gets the markdown files from https://github.com/argoproj/notifications-engine, hence why I opened a PR argoproj/notifications-engine#80 in that repo, which is needed before the failing check can be addressed.

Signed-off-by: Ole-Martin Bratteng <1681525+omBratteng@users.noreply.github.com>
Signed-off-by: Ole-Martin Bratteng <1681525+omBratteng@users.noreply.github.com>
Signed-off-by: Ole-Martin Bratteng <1681525+omBratteng@users.noreply.github.com>
@omBratteng
Copy link
Contributor Author

I would've liked if the overview page from notifications-engine was at the top, but the code in https://github.com/argoproj/argo-cd/blob/master/hack/gen-docs/main.go prevents it

@pasha-codefresh
Copy link
Member

Thank you

@pasha-codefresh pasha-codefresh merged commit 595b825 into argoproj:master Mar 23, 2022
@omBratteng omBratteng deleted the fix-notifications-yam-l branch March 23, 2022 11:19
wojtekidd pushed a commit to wojtekidd/argo-cd that referenced this pull request Apr 25, 2022
…roj#8776 (argoproj#8777)

* docs: fixes the YAML codefence for `Slack` notification service

Signed-off-by: Ole-Martin Bratteng <1681525+omBratteng@users.noreply.github.com>

* chore: update `notifications-engine` to get latest docs

Signed-off-by: Ole-Martin Bratteng <1681525+omBratteng@users.noreply.github.com>

* chore: run `go mod tidy`

Signed-off-by: Ole-Martin Bratteng <1681525+omBratteng@users.noreply.github.com>
Signed-off-by: wojtekidd <wojtek.cichon@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants