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

Documentation formatting issue on page "Analysis & Progressive Delivery" #3509

Closed
bmuschko opened this issue Apr 7, 2024 · 3 comments
Closed
Labels
bug Something isn't working docs Needs documentation/release notes good first issue Good for newcomers

Comments

@bmuschko
Copy link
Contributor

bmuschko commented Apr 7, 2024

Describe the bug

The documentation page "Analysis & Progressive Delivery" has a formatting issue. The provided Markdown code isn't rendered properly and show the markup code instead.

To Reproduce

Navigate to the documentation page Analysis > Overview. The section underneath "The result in the AnalysisRun will have the aggregation of metrics of each template:" doesn't properly format the header of a code snippet and the code snippet itself.

Expected behavior

The header the code snippet are formatted correctly using Markdown.

Screenshots

image

Version

v1.6.6


Message from the maintainers:

Impacted by this bug? Give it a 👍. We prioritize the issues with the most 👍.

@bmuschko bmuschko added the bug Something isn't working label Apr 7, 2024
@blkperl blkperl added the docs Needs documentation/release notes label Apr 8, 2024
@blkperl
Copy link
Contributor

blkperl commented Apr 8, 2024

Hey @bmuschko, thanks for reporting this issue. Would you be interested in opening a PR to fix it?

@blkperl blkperl added the good first issue Good for newcomers label Apr 8, 2024
@bmuschko
Copy link
Contributor Author

bmuschko commented Apr 8, 2024

Yes, absolutely. I am going to work on a PR sometime next week.

@bmuschko
Copy link
Contributor Author

bmuschko commented Apr 8, 2024

@blkperl You can find the PR here: #3511

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Needs documentation/release notes good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants