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

Initial sequence diagram I created for ttahub-2450 ticket #2288

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

fbonds
Copy link
Collaborator

@fbonds fbonds commented Jul 25, 2024

Description of change

Created an initial sequence diagram for the Activity Requests path

How to test

Render with plantUML

$ plantuml ttahub-activity-reports-sequence.puml
view rendered png of diagram

Issue(s)

Checklists

Every PR

  • Meets issue criteria
  • JIRA ticket status updated
  • Code is meaningfully tested
  • Meets accessibility standards (WCAG 2.1 Levels A, AA)
  • API Documentation updated
  • Boundary diagram updated
  • Logical Data Model updated
  • Architectural Decision Records written for major infrastructure decisions
  • UI review complete

Before merge to main

  • OHS demo complete
  • Ready to create production PR

Production Deploy

  • Staging smoke test completed

After merge/deploy

  • Update JIRA ticket status

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the progress, but could this be a folder of distinct sequence diagrams

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. Distinct for each happy path? The happy path for activity reports was what @kryswisnaskas and I discussed in regard to this effort, but I'm happy to do whatever is most valuable. Thanks.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At minimum, docs/sequence-diagrams/*.puml

With a separate file for each category/area of the site:

  • Access
  • Reports
  • dash boards
  • rtr
    ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants