Improved home page documentation#1047

VakarisZ · 2021-03-24T10:56:31Z

What does this PR do?

Fixes #1035

Establishes lingo used throughout the documentation
Explains how monkey works architecturally
Explains the results you'll get and answers to the question "what's the point of using this".

The purpose of these changes is to avoid trivial tech questions and improve the high-level overview of the tool.

…ey works technically

codecov · 2021-03-24T11:00:29Z

Codecov Report

Merging #1047 (e17085d) into develop (5bdb526) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1047   +/-   ##
========================================
  Coverage    27.64%   27.64%           
========================================
  Files          402      402           
  Lines        12833    12833           
========================================
  Hits          3548     3548           
  Misses        9285     9285

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 5bdb526...e17085d. Read the comment docs.

mssalvatore

A few minor grammar changes and wording suggestions.

mssalvatore

Just a few more minor tweaks.

shreyamalviya · 2021-03-25T05:56:56Z

+The results of running Monkey Agents are:
+ - A map which displays how much of the network an attacker can see, what services are accessible and potential propagation routes.
+ - A security report, which displays security issues that Monkey Agents discovered and/or exploited.
+ - A Mitre ATT&CK report, which displays the information about the ATT&CK techniques that Monkey Agents tried to use.


Suggested change

- A Mitre ATT&CK report, which displays the information about the ATT&CK techniques that Monkey Agents tried to use.

- A MITRE ATT&CK report, which displays the information about the ATT&CK techniques that Monkey Agents tried to use.

ghost · 2021-03-25T12:33:38Z

DeepCode failed to analyze this pull request

Something went wrong despite trying multiple times, sorry about that.
Please comment this pull request with "Retry DeepCode" to manually retry, or contact us so that a human can look into the issue.

Improved home page documentation by adding explanation about how monk…

17504c2

…ey works technically

VakarisZ requested a review from mssalvatore March 24, 2021 10:56

mssalvatore reviewed Mar 24, 2021

View reviewed changes