Update docs to account for YAML and statedb changes - Githubissues

InQuest / ThreatIngestor

Extract and aggregate threat intelligence.

https://inquest.readthedocs.io/projects/threatingestor/

GNU General Public License v2.0

831 stars 135 forks source link

Update docs to account for YAML and statedb changes #50

Closed rshipp closed 5 years ago

rshipp commented 5 years ago

Changes include:

Converted all INI examples to YAML
Consistently reference the config as config.yml
Added documentation for new credentials support
Removed all saved_state references from Source config
Updated docs to reference the new state database
Added alt text to images for improved a11y
Reworded some sections for improved clarity
Added references to external YAML syntax guide

Built docs are available at: https://inquest.readthedocs.io/projects/threatingestor/en/issue-46-config-docs/

rshipp commented 5 years ago

Yeah, I had it as .yaml at first and changed it when I realized I already had a .travis.yml and .readthedocs.yml... might as well keep everything consistent. Unfortunate that the official recommendation is the opposite. Thanks for the review. :+1: