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

Develop ATC documentation and host it on Read The Docs #174

Open
yugoslavskiy opened this issue Mar 26, 2020 · 0 comments
Open

Develop ATC documentation and host it on Read The Docs #174

yugoslavskiy opened this issue Mar 26, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@yugoslavskiy
Copy link
Member

Problem

Our readme is huge, hard to read, hard to understand.
There are no informational pages for our entities (like Response Actions), rather than those short descriptions from README.
There are a few blind spots that should be clarified, i.e:

  • how to properly manage Detection Rules severity
  • how to prioritize the implementation, what to do first
  • how all of these supposed to work together

Solution

We need to:

  • store only important information in the README
  • develop detailed documentation and refer to it in the README

Implementation

Develop documentation using mkdocs and store it on Read The Docs.
After that, develop a simplified version of README.

@yugoslavskiy yugoslavskiy added the enhancement New feature or request label Mar 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant