guardicore / guardicore/monkey

Improve configuration documentation

Open
#4,221 0 comments 0 reactions 0 assignees View on GitHub
Documentation
Dominant language
Python
Stars
7.1k
Forks
830
PR merge metrics
No merged PRs in 30d

Description

## Edit existing content 📝

### Pages to modify
- /usage/configuration
- /usage/configuration/credentials
- /usage/configuration/import-export-configuration
- /usage/configuration/network

### Required changes

Improve Infection Monkey's documentation for configuration. Here are some recommendations:

- Move the `credentials` page under `features` and give it an appropriate name.
- Transform the relevant parts of import/export configuration page into a **How To**.
- Transform the relevant parts of import/export configuration page into **Explanation** under `features`.
- Transform the `network` page into an appropriate **Explanation**. Perhaps this should be part of the [Agent Propagation **Explanation**](https://github.com/guardicore/monkey/issues/4215).
- Add a complete reference for the configuration (see #4210 for some information on how to do this).
- Document any other `features` of interest using the appropriate type of documentation according to [Diátaxis](https://diataxis.fr/).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.