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

Write History API website content #16668

Open
4 tasks
jsutantio opened this issue Nov 28, 2024 · 0 comments
Open
4 tasks

Write History API website content #16668

jsutantio opened this issue Nov 28, 2024 · 0 comments
Assignees
Labels
blocked Issue State label to flag PRs and issues to show they are blocked design Work Type label to flag work related to UI/UX Design (e.g. service maps, wireframes, prototypes, etc onboarding-ops Work related to onboarding with a partner. Addressed by the Onboarding & Operations team in RS. platform Platform Team

Comments

@jsutantio
Copy link
Collaborator

jsutantio commented Nov 28, 2024

User Story

As a ReportStream sender I want easy access to documentation of how the Submission History API works.

Description/Use Case

As the MVP of the Submission History API documentation, we have housed the documentation in GitHub per the specifications of the previous ticket (#16288). However, navigating the GH repo for this doc can be difficult for an external sender. Therefore, we recommend linking to the GH content from the ReportStream website.

Product Requirements

Risks/Impacts/Considerations

  • Consider how to either replace (by linking to the GH content) or directly populate the Response Messages page with a comprehensive list of sample responses (see Sample Responses sheet).
  • The Submission History may undergo changes in the near future; therefore, attempt to include content that adapts to these changes or does not require a lot of maintenance (e.g., updating in multiple locations) when those changes are being made.

Acceptance Criteria

  • Layout of content (could be in Figma)
  • Review with design lead
  • Alignment with frontend dev
  • Update Content Tracker (if applicable)
@jsutantio jsutantio added blocked Issue State label to flag PRs and issues to show they are blocked design Work Type label to flag work related to UI/UX Design (e.g. service maps, wireframes, prototypes, etc platform Platform Team labels Nov 28, 2024
@jsutantio jsutantio changed the title Copy of Outline Submission History API Documentation Write History API website content Nov 28, 2024
@jsutantio jsutantio added the onboarding-ops Work related to onboarding with a partner. Addressed by the Onboarding & Operations team in RS. label Dec 2, 2024
@jsutantio jsutantio self-assigned this Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Issue State label to flag PRs and issues to show they are blocked design Work Type label to flag work related to UI/UX Design (e.g. service maps, wireframes, prototypes, etc onboarding-ops Work related to onboarding with a partner. Addressed by the Onboarding & Operations team in RS. platform Platform Team
Projects
None yet
Development

No branches or pull requests

1 participant