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

ER: [docs] Initial data page problems #428

Open
3 of 5 tasks
fyliu opened this issue Oct 28, 2024 · 0 comments
Open
3 of 5 tasks

ER: [docs] Initial data page problems #428

fyliu opened this issue Oct 28, 2024 · 0 comments
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: docs: PD team documentation documentation on PD team processes and architecture, etc. feature: missing ready for prioritization role: missing s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours

Comments

@fyliu
Copy link
Member

fyliu commented Oct 28, 2024

Emergent Requirement - The create initial data page docs is confusing to someone new to it

  • app/core/intial_data/*.json files are present for older initial data but not generated for the current one.
    • This was an extra step that was optimized out.
    • We might still needed the json file. It serves the purpose of keeping track of what our actual initial data are vs. what's in the spreadsheet. If later on we import from the spreadsheet again and the json file changes, we'll know the source data changed.
    • [need decision] Should we keep using the json files or are the actual migration files enough? The problem is the migration files still have a manual step to introduce differences.
  • need language saying not to keep the downloaded .csv file and app/core/scripts/*.py genenerated file
  • manage.py dbshell instruction doesn't work anymore to get into a database shell
    • either update docs to use ./scripts/db.sh
    • or install postgres in the Docker image
    • [need decsion] do we need manage.py dbshell at this point?
      • probably manage.py shell_plus. Check to see if that works first

Issue you discovered this emergent requirement in

Date discovered 2024-10-28

Did you have to do something temporarily

  • YES
    • manual explanation of the instructions and don't commit the intermediate files
  • NO

Who was involved

@del9ra
@fyliu

What happens if this is not addressed

Someone new to the project could be confused about what to do.

Resources

Recommended Action Items

  • Make a new issue
  • Discuss with team
  • Let a Team Lead know

Potential solutions [draft]

@fyliu fyliu added role: missing feature: missing s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours feature: docs: PD team documentation documentation on PD team processes and architecture, etc. complexity: small All steps are laid out in detail so that someone new to the project can work on it labels Oct 28, 2024
@fyliu fyliu added this to the 05. Team Workflow milestone Oct 28, 2024
@github-project-automation github-project-automation bot moved this to 🆕New Issue Review in P: PD: Project Board Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: docs: PD team documentation documentation on PD team processes and architecture, etc. feature: missing ready for prioritization role: missing s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours
Projects
Status: 🆕New Issue Review
Development

No branches or pull requests

2 participants