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

Improve configuration documentation #4221

Open
mssalvatore opened this issue Jun 24, 2024 · 0 comments
Open

Improve configuration documentation #4221

mssalvatore opened this issue Jun 24, 2024 · 0 comments
Labels
Documentation Issues relating to the project's documentation like readme files, guides, etc.

Comments

@mssalvatore
Copy link
Collaborator

mssalvatore commented Jun 24, 2024

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.
  • Add a complete reference for the configuration (see Add credentials collectors reference #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.
@mssalvatore mssalvatore added the Documentation Issues relating to the project's documentation like readme files, guides, etc. label Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues relating to the project's documentation like readme files, guides, etc.
Projects
None yet
Development

No branches or pull requests

1 participant