docs icon indicating copy to clipboard operation
docs copied to clipboard

Automate the generation of SQL responses

Open jseldess opened this issue 5 years ago • 0 comments

Jesse Seldess commented:

As a compliment to automating the testing of SQL commands, we should consider automating the generation of SQL responses, which are throughout our docs. This would keep our SQL responses accurate and helpful for users and would avoid the need to manually maintain them when, for example, the format changes across all responses (rare but has happened) or the details of a specific response changes (new/changed columns, new/changed output).

Possible actions:

  • [ ] Determine where the responses should be stored. Separate files in docs repo, separate repo, etc.?
  • [ ] Automate the generation on a regular basis via CI. Approach may be the same or different to #7066.

Jira Issue: DOC-486

jseldess avatar Apr 03 '20 14:04 jseldess