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: yaml code blocks under Slack notification service doesn't render properly #8776

Closed
3 tasks done
omBratteng opened this issue Mar 14, 2022 · 11 comments
Closed
3 tasks done
Labels
bug Something isn't working

Comments

@omBratteng
Copy link
Contributor

Checklist:

  • I've searched in the docs and FAQ for my answer: https://bit.ly/argocd-faq.
  • I've included steps to reproduce the bug.
  • I've pasted the output of argocd version.

Describe the bug

The YAML examples are rendered as inline code, rather than a code block

To Reproduce

See step 8-10 at https://argo-cd.readthedocs.io/en/stable/operator-manual/notifications/services/slack/

Expected behavior

The YAML examples are rendered as code blocks

Screenshots

image

Version

Both in stable and latest version of docs.

Logs

N/A only docs

@omBratteng omBratteng added the bug Something isn't working label Mar 14, 2022
pasha-codefresh pushed a commit that referenced this issue Mar 23, 2022
…#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>
wojtekidd pushed a commit to wojtekidd/argo-cd that referenced this issue 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>
@GalvinGao
Copy link

Was trying to fix the highlights in #10280 then I noticed such issue here. Any helps needed? I can file a new PR to pick up the fix if you'd like :D

@omBratteng
Copy link
Contributor Author

There is a PR open to fix the latest broken section argoproj/notifications-engine#97

@GalvinGao
Copy link

GalvinGao commented Aug 11, 2022

I noticed that the indentation of the code block in Step 8 is invalid
image

Edit: also Step 9 & 10
image

Mind me contribute to your branch so you could also bring this fix to upstream? (or feel free to just fix this yourself if you got time)

@omBratteng
Copy link
Contributor Author

I see that now. Sure, go ahead. I can cherry-pick the fix into the PR branch.

@pasha-codefresh pasha-codefresh self-assigned this Aug 11, 2022
@omBratteng
Copy link
Contributor Author

I have fixed the indentation, and put you as the author @GalvinGao, so you can get the credit for it.

@omBratteng
Copy link
Contributor Author

Once it gets merged, I'll open a PR here to get the correct version of the go module

@pasha-codefresh pasha-codefresh removed their assignment Aug 12, 2022
crenshaw-dev pushed a commit that referenced this issue Aug 15, 2022
… (#10311)

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

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

* chore: generate notifications 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: Ole-Martin Bratteng <1681525+omBratteng@users.noreply.github.com>
@GalvinGao
Copy link

GalvinGao commented Nov 25, 2022

I think we can close this now as #10311 is merged :D

@omBratteng
Copy link
Contributor Author

Unsure if it is actually out. I see @crenshaw-dev added, and then removed, the cherry-pick label.
Unsure how the release process for this works. But last time I checked (some while ago), the fix wasn't properly out yet.

@omBratteng
Copy link
Contributor Author

Never mind, just checked now. It's out on the stable version of the docs.

@pasha-codefresh
Copy link
Member

Let close it @omBratteng ?

@omBratteng
Copy link
Contributor Author

Should be closed now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants