Epic: Audit differences between code and documented field names

[Neecolaa]

Overview

There are field names in the code that do not currently match our documentation. We need to go through the existing django models, identify the mismatches, and update the code or documentation to comply with our desired naming conventions.

Action Items

• List existing models
• For each model, create a table containing the different field names
• Verify desired naming conventions
• Update the documentation/code

Resources/Instructions

1.01 Code locations

• 1.01.01 /app/core/models.py
• 1.01.02 /app/core/admin.py
• 1.01.03 /app/core/api/serializers.py
• 1.01.04 /app/core/migrations/0002_user_current_job_title_user_current_skills_and_more.py

1.02 People Depot Resources wiki page for links

• ERD
• Table and Field Definitions
• API Endpoint
• 1.03 Spreadsheet, all fields

[fyliu]

I want to note that when we name a ForeignKey field something like "user", Django will create a database column called "user_id". It's Django's convention to drop the "_id" from the end when converting from db to Django code.

These screenshots illustrate how ForeignKey fields in Django actually turn into db columns with "_id" endings

I can find a link to a better description of this when I'm on a computer.