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

[DOCGEN] Create a Readme file per analyzer for documentation purpose #761

Open
nadouani opened this issue May 12, 2020 · 1 comment
Open
Assignees
Labels
category:feature-request Issue is related to a feature request

Comments

@nadouani
Copy link
Contributor

The idea is to automatically produce a better analyzers/responders documentation.

We will create a script that goes through all the analyzer folders and generate a readme.md file that contains the description of all the analyzer flavors

@nadouani nadouani added the category:feature-request Issue is related to a feature request label May 12, 2020
@nadouani nadouani self-assigned this May 12, 2020
@jeromeleonard
Copy link
Contributor

jeromeleonard commented May 12, 2020

## Analyzer's Name

*Description of the analyzer*


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

**Author**: *author* 
**License**: *license*
**Version**: *version* 
**Supported observables types**: list of *dataTypeList*
**Subscription required**: *true/false*
**Free subscription**: *true/false*
**Registration required**: *true/false*
**Third party service URL (if relevant)**: **service_homepage**

#### Description

*Description of the flavor*

#### Requirements

*Requirements*

#### Templates samples

#### Configuration

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

**Default Value**: *defaultValue*
**type**: *type*
**Can contain multiple values**: *multi*
**Required**: *required*
**description**: *descripition*

jeromeleonard added a commit that referenced this issue Jun 5, 2020
jeromeleonard added a commit that referenced this issue Jun 5, 2020
jeromeleonard added a commit that referenced this issue Jun 5, 2020
jeromeleonard added a commit that referenced this issue Jun 5, 2020
jeromeleonard added a commit that referenced this issue Jun 5, 2020
jeromeleonard added a commit that referenced this issue Jun 5, 2020
jeromeleonard added a commit that referenced this issue Jun 19, 2020
jeromeleonard added a commit that referenced this issue Jun 19, 2020
jeromeleonard added a commit that referenced this issue Jun 19, 2020
jeromeleonard added a commit that referenced this issue Jun 19, 2020
jeromeleonard added a commit that referenced this issue Jun 19, 2020
jeromeleonard added a commit that referenced this issue Jun 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:feature-request Issue is related to a feature request
Projects
None yet
Development

No branches or pull requests

2 participants