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.

Sign up for GitHub

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

Jump to bottom

Allowed Values Tutorial #292

Closed

5 tasks done

Tracked by

aj-stein-nist opened this issue Jan 11, 2023 · 4 comments · Fixed by #508

Closed

5 tasks done

Tracked by

Allowed Values Tutorial #292

aj-stein-nist opened this issue Jan 11, 2023 · 4 comments · Fixed by #508

Assignees

Labels

documentation enhancement

Milestone

Metaschema 1.0.0 ...

Collaborator

aj-stein-nist commented Jan 11, 2023 •

edited

Loading

User Story:

As a Metaschema-enabled tool developer, to know what is required for a Level 1 Capability Metaschema library, I want a tutorial in one to walk through parsing and operating on constraints, primarily focused on the allowed-values enforcement.

Goals:

Make tutorials to aid developers of Metaschema-enabled tools to boostrap in their language/runtime/library selection of choice, primarily focused on the allowed-value construct.
Demonstrate practical examples.

Dependencies:

Build Metaschema Level 1 Capabilities Tutorial #260 is reviewed, approved, and merged
Clarify specification for processing combined allowed-value constraints #411

Acceptance Criteria

All website and readme documentation affected by the changes in this issue have been updated. Changes to the website can be made in the docs/content directory of your branch.
A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

{The items above are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.}

The text was updated successfully, but these errors were encountered:

aj-stein-nist added documentation enhancement labels

aj-stein-nist added this to NIST OSCAL Work Board

github-project-automation bot moved this to Todo in NIST OSCAL Work Board

Collaborator Author

aj-stein-nist commented Jan 11, 2023 •

edited

Loading

Discuss with the team whether or not Metapath and context operator (.) ala XPath syntax inherited from Metapath) needs a special treatment or can be handled inline in this tutorial re re feedback in usnistgov/metaschema#275.

aj-stein-nist mentioned this issue

Basic Metaschema Tutorial #275

Merged

5 tasks

Collaborator Author

aj-stein-nist commented Jan 11, 2023 •

edited

Loading

@david-waltermire-nist I am sure we can discuss this on Thursday, but in the meantime: did you want to add this to the current sprint? It was brought up in our last Metaschema developer meeting, and I think you said yeah quickly as we ended the call, but I cannot remember. Adding a note now to discuss here or in the triage meeting.

aj-stein-nist assigned aj-stein-nist and wendellpiez

aj-stein-nist moved this from Todo to In Progress in NIST OSCAL Work Board

aj-stein-nist mentioned this issue

Metapath Tutorial #303

Open

12 tasks

aj-stein-nist changed the title ~~Allowed Values Tutorial~~ Allowed Values Tutoria

aj-stein-nist removed this from NIST OSCAL Work Board

aj-stein-nist changed the title ~~Allowed Values Tutoria~~ Allowed Values Tutorial

aj-stein-nist mentioned this issue

Clarify specification for processing combined allowed-value constraints #411

Closed

5 tasks

Collaborator Author

aj-stein-nist commented Jan 10, 2024

@Arminta-Jenkins-NIST is helping with the remaining items in #485 for the specification, I intend to get this started tomorrow, the remainder of the week, and then the following week.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Add allowed-value constraints tutorial for usnistgov#292

bf9d9b6

aj-stein-nist mentioned this issue

Add allowed-value constraints tutorial #508

Merged

6 tasks

aj-stein-nist linked a pull request

that will close this issue

Add allowed-value constraints tutorial #508

Merged

6 tasks

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Intro and required values section for usnistgov#292

c0dd541

Add introduction and section about how to defined mandatory, required
values for `allowed-values allow-other="no"` for the first segment of
the tutorial.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Intro and required values section for usnistgov#292

b1b17b3

Add introduction and section about how to defined mandatory, required
values for `allowed-values allow-other="no"` for the first segment of
the tutorial.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Recommended values section and conclusion for usnistgov#292

6838f0f

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.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Intro and required values section for usnistgov#292

3982b32

Add introduction and section about how to defined mandatory, required
values for `allowed-values allow-other="no"` for the first segment of
the tutorial.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Recommended values section and conclusion for usnistgov#292

0a22e91

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.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Intro and required values section for usnistgov#292

193b4ef

Add introduction and section about how to defined mandatory, required
values for `allowed-values allow-other="no"` for the first segment of
the tutorial.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Recommended values section and conclusion for usnistgov#292

37cb887

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.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Intro and required values section for usnistgov#292

2d7a7db

Add introduction and section about how to defined mandatory, required
values for `allowed-values allow-other="no"` for the first segment of
the tutorial.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Recommended values section and conclusion for usnistgov#292

a636def

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.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Intro and required values section for usnistgov#292

4f4aa79

Add introduction and section about how to defined mandatory, required
values for `allowed-values allow-other="no"` for the first segment of
the tutorial.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Recommended values section and conclusion for usnistgov#292

56bc56d

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.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Intro and required values section for usnistgov#292

72654ed

Add introduction and section about how to defined mandatory, required
values for `allowed-values allow-other="no"` for the first segment of
the tutorial.

aj-stein-nist added a commit to aj-stein-nist/metaschema that referenced this issue


          Recommended values section and conclusion for usnistgov#292

a2513a2

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.

Collaborator Author

aj-stein-nist commented Jan 19, 2024

So I checked off #411 from deps as the code is merged but the issue is not closed because the code in develop has not merged to main, deployed, and auto-closed the issue.

Per discussion with Dave #508 (comment) and barring no contrasting feedback from the community by COB today, I will leave this issue to be resolved with the closing of #508 and open follow-on issues and work for the related, but separate, tutorials starting next week.

This was referenced Feb 2, 2024

Constraint Tutorials Epic #526

Open

Tutorial for expect #530

Merged

github-merge-queue bot pushed a commit that referenced this issue


          Add allowed-value constraints tutorial (#508)

b00e84f

* Add allowed-value constraints tutorial for #292

* Intro and required values section for #292

Add introduction and section about how to defined mandatory, required
values for `allowed-values allow-other="no"` for the first segment of
the tutorial.

* Recommended values section and conclusion for #292

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.

* Integrate feedback from @david-waltermire:

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).

david-waltermire added this to the Metaschema 1.0.0 milestone

david-waltermire closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment