Database Dictionary Audit for Create:Editor

Recently the database team has started documenting all database tables in db/doc. As an MVP, we've assigned each table to a feature category. We attempted to automate this, and then made rough guesses on the ones that couldn't be automatically identified either using this spreadsheet or just by guessing based on their name and code references. In order to make sure these are accurate, I'm asking every team to take a look at the tables associated with their feature categories assoicated with their stages.

What we need from your team? Look through the list of tables and fix any mistaken labels and update the description field to help folks know what purpose the table serves.

Process (per table)

  1. Are the feature categories correct?
    • Keep in mind that tables can have multiple categories. Look at the list and if there are any other categories it belongs to, add them.
    • If a table has no category that seems to be a perfect match, assign it to the closest match. Tables must have at least one feature category.
    • If the table is assigned to a feature category for a different group, open a merge request changing the category and assign it to the EM for the group responsible for that category.
  2. Update the description of the table to give anybody interacting with it context around the purpose and submit a merge request with the information.
  3. Double check the milestone and introduced_by_url to see if they are accurate

Tables

  • award_emoji

    • snippets is the correct feature category or has been updated
    • award_emoji description has been updated
    • award_emoji milestone and introduced_by_url seem accurate

  • snippet_statistics

    • snippets is the correct feature category or has been updated
    • snippet_statistics description has been updated
    • snippet_statistics milestone and introduced_by_url seem accurate

  • snippet_user_mentions

    • snippets is the correct feature category or has been updated
    • snippet_user_mentions description has been updated
    • snippet_user_mentions milestone and introduced_by_url seem accurate

  • user_agent_details

    • snippets is the correct feature category or has been updated
    • user_agent_details description has been updated
    • user_agent_details milestone and introduced_by_url seem accurate

  • snippet_repositories

    • snippets is the correct feature category or has been updated
    • snippet_repositories description has been updated
    • snippet_repositories milestone and introduced_by_url seem accurate

  • snippets

    • snippets is the correct feature category or has been updated
    • snippets description has been updated
    • snippets milestone and introduced_by_url seem accurate

  • wiki_page_meta

    • wiki is the correct feature category or has been updated
    • wiki_page_meta description has been updated
    • wiki_page_meta milestone and introduced_by_url seem accurate

  • group_wiki_repositories

    • wiki is the correct feature category or has been updated
    • group_wiki_repositories description has been updated
    • group_wiki_repositories milestone and introduced_by_url seem accurate

  • wiki_page_slugs

    • wiki is the correct feature category or has been updated
    • wiki_page_slugs description has been updated
    • wiki_page_slugs milestone and introduced_by_url seem accurate

  • pages_domain_acme_orders

    • pages is the correct feature category or has been updated
    • pages_domain_acme_orders description has been updated
    • pages_domain_acme_orders milestone and introduced_by_url seem accurate

  • application_settings

    • pages is the correct feature category or has been updated
    • application_settings description has been updated
    • application_settings milestone and introduced_by_url seem accurate

  • pages_domains

    • pages is the correct feature category or has been updated
    • pages_domains description has been updated
    • pages_domains milestone and introduced_by_url seem accurate

  • pages_deployment_states

    • pages is the correct feature category or has been updated
    • pages_deployment_states description has been updated
    • pages_deployment_states milestone and introduced_by_url seem accurate

  • project_pages_metadata

    • pages is the correct feature category or has been updated
    • project_pages_metadata description has been updated
    • project_pages_metadata milestone and introduced_by_url seem accurate

  • pages_deployments

    • pages is the correct feature category or has been updated
    • pages_deployments description has been updated
    • pages_deployments milestone and introduced_by_url seem accurate

Why is this effort happening?

There have been many times that issues occur in production, but the the infrastructure team doesn't have the information it needs to identify subject matter experts who can help resolve things quickly. This in turn can delay the time it takes to find and fix pressing issues.

How much time should we expect to spend on this?

Depends, if the team has a lot of tables, it may take a little bit to get all of the information together. If not, this could be very fast. The descriptions are as much or little as the team wants to add. More information may help folks self service better.

How urgent is this?

The urgency is up to the team. If the tables have poor information or are misassigned, that may cause more burden on the team when answering questions.

Edited by David O'Regan