[SPOT-188] [Documentation] As an Apache Spot user I want to have centralized documentation about DNS schema so that I can integrate/implement specific Apache Spot modules

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Labels: spot-documentation
• Assignee: Mitchell
• Reporter: Ricardo Barona
• Created: 29/Jun/17 18:02
• Updated: 08/Aug/17 18:21

Description

Acceptance criteria:

• User have a centralized place to read about DNS schema
  • Field description
  • Field Data type
  • Field Format (i.e. data format)
  • Conditions (i.e. required, shouldn't be null, should be bigger than 3 characters)
• User can tell what columns are used for spot-ml as input
  • What rules apply (filters in code)
• User can tell what columns are used for spot-oa as input
  • What rules apply
• Users can tell what columns are used for spot-ui as input
  • What rules apply
• Users can use their own ingesting process, scoring process or enrichment process and the only thing they need to do is follow the schema guidelines.
  • Their data source should be good for spot-ml or spot-oa or UI.
• Documentation is present in Apache Spot website in a section called Apache Spot Schemas, under DNS data subtitle.
• Documentation is present in README.md or any md file in:
  • spot-ml subfolder, specifying the required schema to use custom data source as input
  • spot-oa subfolder, oa, specifying the required schema to use custom data source as input
  • spot-oa subfolder, ui specifying the required schema to use custom data source as input

Issue Links

• relates to: SPOT-183 [ML] Schema validation for input data