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 for awsSigv4 does not render bullet points correctly #3168

Open
Anurag252 opened this issue Jul 25, 2024 · 2 comments
Open

docs for awsSigv4 does not render bullet points correctly #3168

Anurag252 opened this issue Jul 25, 2024 · 2 comments

Comments

@Anurag252
Copy link
Contributor

Docs for awsSigv4 does not gets rendered correctly.

  • There is an extra _ in the AWS Sig V4 hyperlink and hence the hyperlink is broken.
  • x-amz-accesskey , x-amz-secret, x-amz-time and x-amz-session all should have been bullet points.
  • Service should also be a bullet point, whereas it is currently part of paragraph.

To Reproduce
Add context, for example:

  1. visit https://opensource.zalando.com/skipper/reference/filters/#awssigv4
  2. click on AWS Sig V4 hyperlink
  3. observe x-amz-accesskey , x-amz-secret, x-amz-time, x-amz-session and Service.

Expected behavior

  1. Hyperlink should be functional.
  2. All bullet points should be on new lines.

Observed behavior

  1. Hyperlink is broken.
  2. Bullet points are part of paragraph.
@AlexanderYastrebov
Copy link
Member

Thank you for reporting, feel free to open a fix PR.

@Anurag252
Copy link
Contributor Author

Thank you for reporting, feel free to open a fix PR.

Thanks, I will post a PR soon.

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

No branches or pull requests

2 participants