TheHive-Project / Cortex-Analyzers

Cortex Analyzers Repository
https://TheHive-Project.github.io/Cortex-Analyzers/
GNU Affero General Public License v3.0
434 stars 374 forks source link

[DOCGEN] Create a Readme file per responders for documentation purpose #762

Open nadouani opened 4 years ago

nadouani commented 4 years ago

The idea is to automatically produce a better responders documentation.

We will create a script that goes through all the responder folders and generate a readme.md file.

jeromeleonard commented 4 years ago
## Responder's Name

*Description of the responder*

### Responder Flavor's Name (*foreach flavor* )

**Author**: *author* 
**License**: *license*
**Version**: *version* 
**Homepage**: *url*
**Supported TheHive datatypes**: list of *dataTypeList*
**Subscription required**: *true/false*
**Free subscription**: *true/false*
**Registration required**: *true/false*
**Third party service URL**: *service_homepage* 

#### Description

*Description of the flavor*

#### Requirements

*requirements*

#### Configuration

##### *Name* (*foreach configurationItems*)

**Default Value**: *defaultValue*

**Can contain multiple values**: *multi*
**Required**: *required*
**description**: *descripition*