cockroachdb / cockroachdb/docs

Automate the generation of SQL responses

Open
#7,068 0 comments 0 reactions 0 assignees View on GitHub
C-general-admin P-1
Dominant language
HTML
Stars
212
Forks
476
Avg merge
40m
Merged PRs (30d)
3

Description

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.