-
Notifications
You must be signed in to change notification settings - Fork 21
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
Add allowed-value constraints tutorial #508
Add allowed-value constraints tutorial #508
Conversation
c0dd541
to
b1b17b3
Compare
I would like feedback before removing the draft status and final review.
|
a636def
to
56bc56d
Compare
Add introduction and section about how to defined mandatory, required values for `allowed-values allow-other="no"` for the first segment of the tutorial.
Add introduction and section about how to defined mandatory, recommended values for `allowed-values allow-other="yes"` for the first segment of the tutorial. Added a conclusion for wrap-up given the current draft contents.
56bc56d
to
a2513a2
Compare
I also did some touch-ups on this to relabel the introduction correctly, highlight changes to the model, and more interestingly highlight relevant changes to the example document instances. I didn't realize the tabs and highlight wrapped directives were native Hugo configuration with the templates we use working out of the box, so I added that as well and it just works. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great! Thank you so much for all the hard work on this.
I provided some non-blocking feedback, which could be addressed in another iteration. I believe this tutorial could be released as-is.
Sorry for the delays, I will try to touch this up before the community call today. |
Re #508 (comment), I only got feedback from @david-waltermire that I should separate out the constraint type tutorials and not keep them in one massive tutorial. As this is tutorial 2, follow-on constraint tutorials will be 3, 4, or maybe 5 respectively. Will ask in today's meeting for more feedback but likely move to merge this once I apply PR recommendations and mark for final review and tentative merge. I will open new issues for the follow-on tutorials. |
1. Make second model with allow-other scaffold and include previous model version with arch change, don't make the model changes logically separate. 1. Add detail to conclusion paragraph and explicitly defined learning objectives and that they were met. 1. Not explicit to review but caught when touching up models: make sure the model version numbers in `<schema-version/>` in the tutorials bump up with each change to make sense and signify a change. (NOTE: The bumps are in patch number, not minor number, which is odd open review issue to check that later).
Sorry for the delay, this is ready for final review with feedback from Updated in 889758b and feedback integrated. |
Committer Notes
Begin the allowed-value constraints tutorial and potentially others, pending feedback. Closes #292.
All Submissions:
Changes to Core Features:
Have you added an explanation of what your changes do and why you'd like us to include them?This is a documentation update.Have you written new tests for your core changes, as applicable?N/A this is a documentation update.