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

Data Flow Documentation/Diagrams #65

Closed
dpgraham4401 opened this issue Jul 22, 2022 · 1 comment
Closed

Data Flow Documentation/Diagrams #65

dpgraham4401 opened this issue Jul 22, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation wontfix This will not be worked on
Milestone

Comments

@dpgraham4401
Copy link
Member

🚀 Feature Request

Is your feature request related to a problem? Please describe.

  • Documentation (preferably with visual aids) showing the business logic (steps) Haztrak uses when interfacing with RCRAInfo.
  • This is a very high level task, no code required, but would be good to do before we start diving into the meat of the project (interfacing with RCRAInfo)

Describe the solution you'd like

  • the docs directory should contain a file/section on the workflow for actions that interface with RCRAInfo's web services.
  • example off top of my head
    • Title: Editing a manifest through the post-submission correction processing
    1. User Select edit manifest
    2. haztrak checks that the current version is up-to-date with RCRAInfo
    3. if not, it ask the user if they'd like to update with the most recent info before editing
    4. if yes, haztrak pulls the most recent manifest from RCRAInfo and serves to user for editing

Describe alternatives you've considered

  • we just wing it and don't plan this stuff out beforehand
@dpgraham4401 dpgraham4401 self-assigned this Jul 22, 2022
@dpgraham4401 dpgraham4401 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers question/discussion Further information is requested labels Jul 22, 2022
@dpgraham4401 dpgraham4401 removed their assignment Jul 22, 2022
@dpgraham4401 dpgraham4401 changed the title RCRAInfo Interfacing Business logic Documentation for RCRAInfo interfacing relavant businees login Aug 12, 2022
@dpgraham4401 dpgraham4401 changed the title Documentation for RCRAInfo interfacing relavant businees login Documentation for RCRAInfo interfacing relavant businees logic Aug 15, 2022
@dpgraham4401 dpgraham4401 changed the title Documentation for RCRAInfo interfacing relavant businees logic Data Flow Documentation/Diagrams Sep 26, 2022
@dpgraham4401 dpgraham4401 added this to the Backlog milestone Mar 9, 2023
@dpgraham4401 dpgraham4401 added wontfix This will not be worked on and removed help wanted Extra attention is needed good first issue Good for newcomers question/discussion Further information is requested labels May 5, 2023
@dpgraham4401
Copy link
Member Author

closing this as this really belongs in the e-manifest documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

1 participant