1890: Add documentation for making migrations in user_group

[erinysong]

Ticket

Resolves #1890

Changes

Add documentation directing people updating user group permissions to custom migration instructions documented in 0037_create_groups_v01.py.
Fixes some errors in dependency comments on user_group migrations. Am open to removing these comments on dependencies if we don't find them necessary to comment in user group migrations.

Context for reviewers

Setup

Code Review Verification Steps

As the original developer, I have

Satisfied acceptance criteria and met development standards

• Met the acceptance criteria, or will meet them in a subsequent PR
• Created/modified automated tests
• Added at least 2 developers as PR reviewers (only 1 will need to approve)
• Messaged on Slack or in standup to notify the team that a PR is ready for review
• Changes to “how we do things” are documented in READMEs and or onboarding guide
• If any model was updated to modify/add/delete columns, makemigrations was ran and the associated migrations file has been commited.

Ensured code standards are met (Original Developer)

• All new functions and methods are commented using plain language
• Did dependency updates in Pipfile also get changed in requirements.txt?
• Interactions with external systems are wrapped in try/except
• Error handling exists for unusual or missing values

Validated user-facing changes (if applicable)

• New pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
• Checked keyboard navigability
• Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
• Add at least 1 designer as PR reviewer

As a code reviewer, I have

Reviewed, tested, and left feedback about the changes

• Pulled this branch locally and tested it
• Reviewed this code and left comments
• Checked that all code is adequately covered by tests
• Made it clear which comments need to be addressed before this work is merged
• If any model was updated to modify/add/delete columns, makemigrations was ran and the associated migrations file has been commited.

Ensured code standards are met (Code reviewer)

• All new functions and methods are commented using plain language
• Interactions with external systems are wrapped in try/except
• Error handling exists for unusual or missing values
• (Rarely needed) Did dependency updates in Pipfile also get changed in requirements.txt?

Validated user-facing changes as a developer

• New pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing

• Checked keyboard navigability

• Meets all designs and user flows provided by design/product

• Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)

• Tested with multiple browsers, the suggestion is to use ones that the developer didn't (check off which ones were used)

  • Chrome
  • Microsoft Edge
  • FireFox
  • Safari

• (Rarely needed) Tested as both an analyst and applicant user

Note: Multiple code reviewers can share the checklists above, a second reviewers should not make a duplicate checklist

As a designer reviewer, I have

Verified that the changes match the design intention

• Checked that the design translated visually
• Checked behavior
• Checked different states (empty, one, some, error)
• Checked for landmarks, page heading structure, and links
• Tried to break the intended flow

Validated user-facing changes as a designer

• Checked keyboard navigability

• Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)

• Tested with multiple browsers (check off which ones were used)

  • Chrome
  • Microsoft Edge
  • FireFox
  • Safari

• (Rarely needed) Tested as both an analyst and applicant user

Screenshots

[github-actions]

🥳 Successfully deployed to developer sandbox es.

[github-actions]

🥳 Successfully deployed to developer sandbox es.

[github-actions]

🥳 Successfully deployed to developer sandbox es.

[CocoByte]

LGTM

[abroddrick]

Hey Erin can we actually move some of these instructions to developer readme? Or even duplicating it in the developer readme given that this is such a weird thing. Another place this could go instead is the migration troubleshooting document or the document on databases. I will leave it to you on which one feels like a doc you may see it in first as a new developer.

Also sorry on the confusion on this ticket. You don't need to update old migration files as migration files should be left untouched when possible after they are applied.

[erinysong]

Good point, thank you @abroddrick! I just duplicated the docs to the user-permissions docs but let me know if we should remove these docs from user_group to remove redundancy. Also reverted the docs changes to our migration files

[github-actions]

🥳 Successfully deployed to developer sandbox es.

[github-actions]

🥳 Successfully deployed to developer sandbox es.

[abroddrick]

non blocking suggestion

Suggested change

	2. Follow the steps in 0037_create_groups_v01.py to create a duplicate
	2. Follow the steps in the migration file "0037_create_groups_v01.py" to create a duplicate

or alternatively, you could make this a link

[erinysong]

Just added the suggestion - thank you!

[github-actions]

🥳 Successfully deployed to developer sandbox es.

Addressed these changes as discussed in sprint planning meeting