Skip to content

Improve report documentation #913

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
merged 3 commits into from
Jan 6, 2021
Merged

Improve report documentation #913

merged 3 commits into from
Jan 6, 2021

Conversation

mssalvatore
Copy link
Collaborator

@mssalvatore mssalvatore commented Jan 4, 2021 •
edited
Loading

What does this PR do?

Fixes #887

Add any further explanations here.

PR Checklist

  • Have you added an explanation of what your changes do and why you'd like to include them?
  • Is the TravisCI build passing?
  • Was the documentation framework updated to reflect the changes?

Testing Checklist

  • Added relevant unit tests? (N/A)
  • Have you successfully tested your changes locally? Elaborate:

    Tested by running hugo -D server and viewing the modified pages.

  • If applicable, add screenshots or log transcripts of the feature working

image

@mssalvatore mssalvatore force-pushed the improve-report-documentation branch from d503305 to ae614c8 Compare January 4, 2021 20:38
@codecov
Copy link

codecov bot commented Jan 4, 2021 •
edited
Loading

Codecov Report

Merging #913 (708bb88) into develop (1f12975) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #913   +/-   ##
========================================
  Coverage    60.58%   60.58%           
========================================
  Files          166      166           
  Lines         4955     4955           
========================================
  Hits          3002     3002           
  Misses        1953     1953

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 1f12975...708bb88. Read the comment docs.

VakarisZ
VakarisZ reviewed Jan 6, 2021
View reviewed changes
docs/content/reports/_index.md Outdated
@@ -10,4 +10,4 @@ pre = "<i class='fas fa-scroll'></i> "

The Monkey offers three reports:

{{% children %}}
{{% children description="true" %}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Add style="p" here, to have a more proper format for the list.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That ends up looking like this. Is this what we want?

image

VakarisZ
VakarisZ reviewed Jan 6, 2021
View reviewed changes
Copy link
Contributor

@VakarisZ VakarisZ left a comment

Choose a reason for hiding this comment

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

Fix my comment and you can merge

@mssalvatore mssalvatore merged commit 62541d2 into develop Jan 6, 2021
@mssalvatore mssalvatore deleted the improve-report-documentation branch January 6, 2021 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@VakarisZ VakarisZ VakarisZ left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve report documentation
3 participants
@mssalvatore @VakarisZ @msal-guardicore