Skip to content

docs: add code annotations in analysis reference page #3815

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.

Sign up for GitHub

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

Jump to bottom
Merged
mowies merged 5 commits into from
Nov 4, 2024
Merged

docs: add code annotations in analysis reference page #3815

mowies merged 5 commits into from
Nov 4, 2024

Conversation

@tanishkandira
Copy link
Contributor

@tanishkandira tanishkandira commented Oct 30, 2024 •
edited by mowies
Loading

Description

Added the code annotations to the Analysis reference pages in the JSON code block & removed the below made description of the code block.
Please review my changes.

Fixes #3040

@tanishkandira tanishkandira requested review from a team as code owners October 30, 2024 15:25
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 30, 2024
@tanishkandira tanishkandira changed the title docs: Added code annotation in analysis reference page docs: added code annotation in analysis reference page Oct 30, 2024
@mowies mowies changed the title docs: added code annotation in analysis reference page docs: add code annotations in analysis reference page Oct 30, 2024
mowies
mowies reviewed Oct 30, 2024
View reviewed changes
Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

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

please fix the linter issues, other than that LGTM i think

@odubajDT
Copy link
Contributor

odubajDT commented Oct 30, 2024

please fix the linter issues, other than that LGTM i think

here is the list of errors

 docs/docs/reference/crd-reference/analysis.md:189:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/docs/reference/crd-reference/analysis.md:191:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/docs/reference/crd-reference/analysis.md:193:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/docs/reference/crd-reference/analysis.md:195:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/docs/reference/crd-reference/analysis.md:197:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/docs/reference/crd-reference/analysis.md:198:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/docs/reference/crd-reference/analysis.md:199:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/docs/reference/crd-reference/analysis.md:201:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/docs/reference/crd-reference/analysis.md:202:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2]
docs/docs/reference/crd-reference/analysis.md:223 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

@tanishkandira
docs: fixed spacing lints
6b2a32c 
Signed-off-by: tanishkandira <[email protected]>
@tanishkandira
Copy link
Contributor Author

tanishkandira commented Oct 30, 2024

Please check again , the lints must be fixed now.
Thanks.

odubajDT
odubajDT previously approved these changes Oct 31, 2024
View reviewed changes
mowies
mowies reviewed Oct 31, 2024
View reviewed changes
@mowies
remove whitespaces at end of lines
8e6cadf 
Signed-off-by: Moritz Wiesinger <[email protected]>
mowies
mowies reviewed Oct 31, 2024
View reviewed changes
Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

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

please add a small note before the code block:

> Note: Please check the inline annotations to get more information about the particular lines you are interested in.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 1, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

mowies
mowies approved these changes Nov 4, 2024
View reviewed changes
Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

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

LGTM! thanks for your contribution!

@mowies mowies merged commit b29c059 into keptn:main Nov 4, 2024
11 checks passed
@keptn-bot keptn-bot mentioned this pull request Nov 4, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@odubajDT odubajDT odubajDT approved these changes

+1 more reviewer

@mowies mowies mowies approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Use code annotations to increase usability of Analysis reference page

3 participants

@tanishkandira @odubajDT @mowies