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

Improved home page documentation #1047

Merged
merged 4 commits into from
Mar 25, 2021
Merged

Improved home page documentation #1047

merged 4 commits into from
Mar 25, 2021

Conversation

VakarisZ
Copy link
Contributor

What does this PR do?

Fixes #1035

  1. Establishes lingo used throughout the documentation
  2. Explains how monkey works architecturally
  3. 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.

image

@codecov
Copy link

codecov bot commented Mar 24, 2021

Codecov Report

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

Impacted file tree graph

@@           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.

docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@mssalvatore mssalvatore left a comment

Choose a reason for hiding this comment

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

A few minor grammar changes and wording suggestions.

@VakarisZ VakarisZ changed the title Improved home page documentation by adding explanation about how monk… Improved home page documentation Mar 24, 2021
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@mssalvatore mssalvatore left a comment

Choose a reason for hiding this comment

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

Just a few more minor tweaks.

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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
Copy link

ghost commented Mar 25, 2021

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.

@mssalvatore mssalvatore merged commit 74d9bf7 into develop Mar 25, 2021
@VakarisZ VakarisZ deleted the home_docs_improvement branch April 12, 2021 06:49
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

Successfully merging this pull request may close these issues.

About (homepage) improvement
3 participants