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

Some ValueSets Do Not Serialize Cleanly Into a Markdown Table #343

Closed
MauriceReeves-usds opened this issue Jan 19, 2021 · 2 comments
Closed
Assignees
Labels
backend Work Type label to flag work that requires back-end engineering bug Issue Type label to flag an issue that is a bug good-first-issue Tickets that would be a great place for newly onboarded folks to begin pipeline Cle, Jim, Yemi, Carlos, Gage, Derek, Ott

Comments

@MauriceReeves-usds
Copy link
Collaborator

When generating Markdown for valuesets, some do not serialize cleanly and break formatting. See an example below.

Screen Shot 2021-01-19 at 2.00.07 PM.png

When serializing properly, it should look like this instead:

Screen Shot 2021-01-19 at 1.56.08 PM.png

@MauriceReeves-usds MauriceReeves-usds added bug Issue Type label to flag an issue that is a bug backend Work Type label to flag work that requires back-end engineering good-first-issue Tickets that would be a great place for newly onboarded folks to begin help-wanted Tickets seeking ownership over their completion labels Jan 19, 2021
@MauriceReeves-usds
Copy link
Collaborator Author

Acceptance Criteria:

  • When we generate docs, the value sets appear as expected in the markdown

Notes:
We have integrated documentation generation logic into the application that can be run via the command line: ./prime generate-docs. This creates all the markdown files based off the schemas in our documentation folder, and it's executed on builds and PR creation. We have this so non-technical people are able to get more information about the schemas, expected values, etc.

The documentation is currently pretty sparse, but it's a good first resource for folks.

@MauriceReeves-usds MauriceReeves-usds added receiver Analytics label to flag work related to State/Receiver/STLT features and removed help-wanted Tickets seeking ownership over their completion labels Jul 2, 2021
@MauriceReeves-usds MauriceReeves-usds added the onboarding-ops Work related to onboarding with a partner. Addressed by the Onboarding & Operations team in RS. label Oct 12, 2021
@loripusey loripusey added experience Team label to flag issues owned by the Experience Team pipeline Cle, Jim, Yemi, Carlos, Gage, Derek, Ott backend Work Type label to flag work that requires back-end engineering and removed experience Team label to flag issues owned by the Experience Team receiver Analytics label to flag work related to State/Receiver/STLT features backend Work Type label to flag work that requires back-end engineering onboarding-ops Work related to onboarding with a partner. Addressed by the Onboarding & Operations team in RS. labels Oct 14, 2021
@clediggins-usds clediggins-usds added Epic ZenHub Epic label and removed Epic ZenHub Epic label labels Nov 23, 2021
@oslynn
Copy link
Collaborator

oslynn commented Nov 26, 2021

The reason why the ValueSets Do Not Serialize Cleanly Into a Markdown Table as stated above. It is because of the common.valuesets hl70078 code: ">" character represent blockquote control character of Markdown file format. The solution is to use code: ">" instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Work Type label to flag work that requires back-end engineering bug Issue Type label to flag an issue that is a bug good-first-issue Tickets that would be a great place for newly onboarded folks to begin pipeline Cle, Jim, Yemi, Carlos, Gage, Derek, Ott
Projects
None yet
Development

No branches or pull requests

7 participants