Integrator documentation

[amercader]

Description

Coupled with big improvements in UX we need to prioritise a clear and comprehensive documentation that guides users on how to make the most of the service. There should be a general introduction to data validation and how the service works.

The critical parts are how to enable / add sources and the goodtables.yml syntax. For adding sources we need dedicated page for each backend covering specifics:

• GitHub: triggers created, permissions, badges, status checks
• Amazon S3: permissions, regions (?)

We also need a page for more advanced topics like the API and authorization. And when they are in place, different plans.

My suggestion is to set up a separate static site on a custom subdomain (help.goodtables.io) that allows us to iterate and improve the docs fast.

Tasks

• [ ] Set up a static site that autodeploys via Travis or similar
• [ ] Design that matches the main goodtables.io site
• [ ] Service overview, CI analogy, good examples of sources and erorrs
• [ ] Add GitHub repo
• [ ] Add Amazon S3 bucket
• [ ] goodtables.yml syntax
• [ ] API and authorization

Estimate

4

[danfowler]

In my role as Developer Advocate, I would be interested in assisting here.

[amercader]

@danfowler That would be great! Is there something else important you think we should cover?

[danfowler]

• [ ] Minimum permissions for S3 user integration

[gabelula]

Add good examples on goodtables.yml and sources.