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

Update the API Guide with Code mapping template & instructions #16850

Merged
merged 7 commits into from
Dec 24, 2024

Conversation

etanb
Copy link
Collaborator

@etanb etanb commented Dec 18, 2024

Updates the API Guide.

Fixes #16628

@etanb etanb added experience Team label to flag issues owned by the Experience Team trialfrontend03 Trigger a trialfrontend03 deployment labels Dec 18, 2024
Copy link
Contributor

github-actions bot commented Dec 18, 2024

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

Copy link
Collaborator

@jillian-hammer jillian-hammer left a comment

Choose a reason for hiding this comment

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

thanks @etanb this is looking great! a few notes:

  • Step 1: Some of the text is missing the bold styling. ("Note: If you’re testing OTC data, use the NIST HL7 General Validation Tool and select RADx MARS HL7v2 from the Tool Scopes dropdown. Navigate to the Context-free tab and select the Onboarding profile group. Correct any errors you receive.")
  • Step 2.2: Remove period after header Set up your file
  • Can you double check that that anchor links for the accordions is working and are unique to that accordion? For example, when I open accordion for Step 2.1, the URL changes to developer-resources/api/getting-started#1 but that is the same URL when I open Step 3.1. and when I try to open that link in a new tab, it does not auto link to that open accordion. it just opens the page from the top.

(Note: If you’re testing OTC data, use the <A href={site.external.nistGeneralValidationTool.url}>NIST HL7 General Validation Tool</A> and
selectRADx MARS HL7v2 from the tool scope dropdown. Navigate to the Context-free tab and select the Onboarding profile group).
Note: If you’re testing OTC data, use the <A href={site.external.nistGeneralValidationTool.url}>NIST HL7 General Validation Tool</A> and
select** RADx MARS HL7v2** from the **Tool Scopes** dropdown. Navigate to the **Context-free** tab and select the **Onboarding** profile group.
Copy link
Collaborator

Choose a reason for hiding this comment

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

  • fix bold styling (screenshot from preview link below)
image

Copy link
Collaborator

@jillian-hammer jillian-hammer left a comment

Choose a reason for hiding this comment

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

LGTM thanks @etanb!!

@etanb etanb enabled auto-merge December 19, 2024 22:33
Copy link
Contributor

Branch deployed to Chromatic 🚀.

  • ⚠️ Detected 0 tests with visual changes.
  • ✅ All tests passed.

View via:

@etanb etanb merged commit 311d2fd into main Dec 24, 2024
31 of 33 checks passed
@etanb etanb deleted the experience/16628/api-guide-code-map branch December 24, 2024 22:46
Copy link
Contributor

⚠️ Broken Links ⚠️

https://www.cdc.gov/od/foia

Error: Request failed with status code 403


https://www.hhs.gov/vulnerability-disclosure-policy/index.html

Error: Request failed with status code 403


❌ /assets/xlsm/20241204_ReportStream-Mapping-Template.xlsm

Error: Internal link: Page error


https://www.cdc.gov/poxvirus/mpox/lab-personnel/report-results.html

Error: Request failed with status code 404


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
experience Team label to flag issues owned by the Experience Team trialfrontend03 Trigger a trialfrontend03 deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the API Guide with Code mapping template & instructions
3 participants