Database Dictionary Audit for Plan:Project Management
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)
- 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.
- Update the description of the table to give anybody interacting with it context around the purpose and submit a merge request with the information.
- Double check the
milestone
andintroduced_by_url
to see if they are accurate
Tables
-
label_links -
team_planning is the correct feature category or has been updated -
label_links description has been updated -
label_links milestone
andintroduced_by_url
seem accurate
-
-
labels -
team_planning is the correct feature category or has been updated -
labels description has been updated -
labels milestone
andintroduced_by_url
seem accurate
-
-
boards_epic_list_user_preferences -
team_planning is the correct feature category or has been updated -
boards_epic_list_user_preferences description has been updated -
boards_epic_list_user_preferences milestone
andintroduced_by_url
seem accurate
-
-
custom_emoji -
team_planning is the correct feature category or has been updated -
custom_emoji description has been updated -
custom_emoji milestone
andintroduced_by_url
seem accurate
-
-
boards_epic_board_recent_visits -
team_planning is the correct feature category or has been updated -
boards_epic_board_recent_visits description has been updated -
boards_epic_board_recent_visits milestone
andintroduced_by_url
seem accurate
-
-
board_project_recent_visits -
team_planning is the correct feature category or has been updated -
board_project_recent_visits description has been updated -
board_project_recent_visits milestone
andintroduced_by_url
seem accurate
-
-
issue_links -
team_planning is the correct feature category or has been updated -
issue_links description has been updated -
issue_links milestone
andintroduced_by_url
seem accurate
-
-
boards_epic_board_labels -
team_planning is the correct feature category or has been updated -
boards_epic_board_labels description has been updated -
boards_epic_board_labels milestone
andintroduced_by_url
seem accurate
-
-
boards_epic_board_positions -
team_planning is the correct feature category or has been updated -
boards_epic_board_positions description has been updated -
boards_epic_board_positions milestone
andintroduced_by_url
seem accurate
-
-
label_priorities -
team_planning is the correct feature category or has been updated -
label_priorities description has been updated -
label_priorities milestone
andintroduced_by_url
seem accurate
-
-
work_item_types -
team_planning is the correct feature category or has been updated -
work_item_types description has been updated -
work_item_types milestone
andintroduced_by_url
seem accurate
-
-
issue_assignees -
team_planning is the correct feature category or has been updated -
issue_assignees description has been updated -
issue_assignees milestone
andintroduced_by_url
seem accurate
-
-
issuable_severities -
team_planning is the correct feature category or has been updated -
issuable_severities description has been updated -
issuable_severities milestone
andintroduced_by_url
seem accurate
-
-
issues -
team_planning is the correct feature category or has been updated -
issues description has been updated -
issues milestone
andintroduced_by_url
seem accurate
-
-
boards_epic_user_preferences -
team_planning is the correct feature category or has been updated -
boards_epic_user_preferences description has been updated -
boards_epic_user_preferences milestone
andintroduced_by_url
seem accurate
-
-
resource_weight_events -
team_planning is the correct feature category or has been updated -
resource_weight_events description has been updated -
resource_weight_events milestone
andintroduced_by_url
seem accurate
-
-
notes -
team_planning is the correct feature category or has been updated -
notes description has been updated -
notes milestone
andintroduced_by_url
seem accurate
-
-
resource_milestone_events -
team_planning is the correct feature category or has been updated -
resource_milestone_events description has been updated -
resource_milestone_events milestone
andintroduced_by_url
seem accurate
-
-
resource_state_events -
team_planning is the correct feature category or has been updated -
resource_state_events description has been updated -
resource_state_events milestone
andintroduced_by_url
seem accurate
-
-
todos -
team_planning is the correct feature category or has been updated -
todos description has been updated -
todos milestone
andintroduced_by_url
seem accurate
-
-
board_group_recent_visits -
team_planning is the correct feature category or has been updated -
board_group_recent_visits description has been updated -
board_group_recent_visits milestone
andintroduced_by_url
seem accurate
-
-
issue_user_mentions -
team_planning is the correct feature category or has been updated -
issue_user_mentions description has been updated -
issue_user_mentions milestone
andintroduced_by_url
seem accurate
-
-
draft_notes -
team_planning is the correct feature category or has been updated -
draft_notes description has been updated -
draft_notes milestone
andintroduced_by_url
seem accurate
-
-
issue_emails -
team_planning is the correct feature category or has been updated -
issue_emails description has been updated -
issue_emails milestone
andintroduced_by_url
seem accurate
-
-
sprints -
team_planning is the correct feature category or has been updated -
sprints description has been updated -
sprints milestone
andintroduced_by_url
seem accurate
-
-
board_assignees -
team_planning is the correct feature category or has been updated -
board_assignees description has been updated -
board_assignees milestone
andintroduced_by_url
seem accurate
-
-
board_labels -
team_planning is the correct feature category or has been updated -
board_labels description has been updated -
board_labels milestone
andintroduced_by_url
seem accurate
-
-
board_user_preferences -
team_planning is the correct feature category or has been updated -
board_user_preferences description has been updated -
board_user_preferences milestone
andintroduced_by_url
seem accurate
-
-
iterations_cadences -
team_planning is the correct feature category or has been updated -
iterations_cadences description has been updated -
iterations_cadences milestone
andintroduced_by_url
seem accurate
-
-
milestones -
team_planning is the correct feature category or has been updated -
milestones description has been updated -
milestones milestone
andintroduced_by_url
seem accurate
-
-
timelogs -
team_planning is the correct feature category or has been updated -
timelogs description has been updated -
timelogs milestone
andintroduced_by_url
seem accurate
-
-
notification_settings -
team_planning is the correct feature category or has been updated -
notification_settings description has been updated -
notification_settings milestone
andintroduced_by_url
seem accurate
-
-
analytics_cycle_analytics_project_value_streams -
planning_analytics is the correct feature category or has been updated -
analytics_cycle_analytics_project_value_streams description has been updated -
analytics_cycle_analytics_project_value_streams milestone
andintroduced_by_url
seem accurate
-
-
resource_iteration_events -
planning_analytics is the correct feature category or has been updated -
resource_iteration_events description has been updated -
resource_iteration_events milestone
andintroduced_by_url
seem accurate
-
-
resource_label_events -
planning_analytics is the correct feature category or has been updated -
resource_label_events description has been updated -
resource_label_events milestone
andintroduced_by_url
seem accurate
-
-
award_emoji -
team_planning
is the correct feature category or has been updated -
award_emoji description has been updated -
award_emoji milestone
andintroduced_by_url
seem accurate
-
-
subscriptions -
Fix feature category from continuous_integration
toteam_planning
based on comment here -
subscriptions description has been updated -
subscriptions milestone
andintroduced_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.