[jira] [Created] (VCL-876) Update "Database Schema" documentaion

["Andy Kurth (JIRA)" <ji...@apache.org>]

Andy Kurth created VCL-876:
------------------------------

             Summary: Update "Database Schema" documentaion
                 Key: VCL-876
                 URL: https://issues.apache.org/jira/browse/VCL-876
             Project: VCL
          Issue Type: Documentation
          Components: documentation
            Reporter: Andy Kurth
            Priority: Minor


This page is out of date:
https://vcl.apache.org/dev/database-schema.html

There is a disconnect between the database schema and related documentation.  Rather than simply update the page, I propose including documentation in the schema itself.  MySQL/MariaDB allow tables and columns to include a comment property.  The existing documentation could be added comment properties in _vcl.sql_.

Another benefit is the the comments are displayed in phpMyAdmin when hovering over a column or table.

A fairly simple script could be written to parse the comments and generate output which could be displayed on either the page noted above or the Confluence wiki.

If this is agreed upon, we should update the release notes to include reminders:
* Check _vcl.sql_ for missing or insufficient comments
* Parse the comments and update the documentation



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)