Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Event table must-could-should #279

Closed
8 of 12 tasks
fyliu opened this issue May 1, 2024 · 1 comment · Fixed by #292
Closed
8 of 12 tasks

Update Event table must-could-should #279

fyliu opened this issue May 1, 2024 · 1 comment · Fixed by #292
Assignees
Labels
complexity: missing feature: docs: team guide Same as PD team documentation? feature: update table role: back end s: PD team stakeholder: People Depot Team size: 3pt Can be done in 13-18 hours

Comments

@fyliu
Copy link
Member

fyliu commented May 1, 2024

Overview

We need to update the event table model in django to utilize the practice area table instead of the outdated role table.

Details

The old model issues for this table are

Action Items

  • Update existing Django model
  • Write a test for the new relationships this model will have with other models (e.g., creating a user and assigning them a set of permissions on a project) if any.
  • Update API end point
  • Update API unit tests
  • Document the endpoint in Swagger

Changes Needed

Columns to Remove

  • must_roles - int[] (role_id)
  • should_roles - int[] (role_id)
  • could_roles - int[] (role_id)

Columns to Add

  • must_attend - JSON[]
  • should_attend - JSON[]
  • could_attend - JSON[]

Additional Changes

  • Add example JSON to the documentation (like the one in the ERD)

JSON Example:

[
  {
    practice_area: engineering,
    permission_level: practiceLeadProject
  },
  {
    practice_area: pm,
    permission_level: practiceLeadProject
  }
]

Resources

Practice Areas:

  • Development
  • Project Management
  • Design
  • Professional Development

Permission Types:

  • adminGlobal
  • adminBrigade
  • adminProject
  • practiceLeadProject
  • practiceLeadJrProject
  • memberProject
  • memberGeneral

Test suggestions

  • create an "All" event for the PeopleDepot project with these attendance suggestions
    • must: adminProject, practiceLeadProject, practiceLeadJrProject
    • should: memberProject
    • could: memberGeneral
  • need an example that utilizes Practice Area values
@fyliu fyliu added role: back end size: 2pt Can be done in 7-12 hours s: PD team stakeholder: People Depot Team feature: update table feature: docs: PD team documentation documentation on PD team processes and architecture, etc. labels May 1, 2024
@fyliu fyliu added this to the v0.01 - initial setup milestone May 1, 2024
@fyliu fyliu added size: 3pt Can be done in 13-18 hours and removed size: 2pt Can be done in 7-12 hours labels May 2, 2024
@freaky4wrld freaky4wrld self-assigned this May 23, 2024
@fyliu
Copy link
Member Author

fyliu commented May 29, 2024

Questions:

Check the Test Suggestions section to see if that one makes sense.

We need an example usage of these JSON fields that utilizes Practice Area values.

Do all the Permission Types have to have a Practice Area value or only certain ones like practiceLeadProject, practiceLeadJrProject, memberProject need one?

@fyliu fyliu added feature: docs: team guide Same as PD team documentation? and removed feature: docs: PD team documentation documentation on PD team processes and architecture, etc. labels Jun 3, 2024
@fyliu fyliu closed this as completed in #292 Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: missing feature: docs: team guide Same as PD team documentation? feature: update table role: back end s: PD team stakeholder: People Depot Team size: 3pt Can be done in 13-18 hours
Projects
Status: ✅Done
Development

Successfully merging a pull request may close this issue.

3 participants