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

Basic Metaschema Tutorial #275

Conversation

aj-stein-nist
Copy link
Collaborator

@aj-stein-nist aj-stein-nist commented Dec 16, 2022

Committer Notes

Add basic metaschema tutorial for #260.

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you squashed any non-relevant commits and commit messages? [instructions]
  • Do all automated CI/CD checks pass?

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all website](https://pages.nist.gov/metaschema) and readme documentation affected by the changes you made? Changes to the website can be made in the website/content directory of your branch.

@aj-stein-nist aj-stein-nist self-assigned this Dec 16, 2022
@aj-stein-nist aj-stein-nist force-pushed the 260-build-metaschema-level-1-capabilities-tutorial branch 4 times, most recently from 84f9a8a to ddd0d04 Compare December 23, 2022 17:40
@aj-stein-nist aj-stein-nist changed the title [WIP] Basic Metaschema Tutorial Basic Metaschema Tutorial Dec 23, 2022
@aj-stein-nist aj-stein-nist marked this pull request as ready for review December 23, 2022 19:09
@aj-stein-nist aj-stein-nist linked an issue Dec 23, 2022 that may be closed by this pull request
4 tasks
@aj-stein-nist
Copy link
Collaborator Author

aj-stein-nist commented Jan 6, 2023

@brianruf suggested collapsing the code samples (of the Metaschema definitions and equivalent instances) would increase the accessibility of this tutorial.

Brian opened this in response: #277. Thanks to him!

@aj-stein-nist
Copy link
Collaborator Author

Feedback from @brianruf and @jimstevensedc: this tutorial and/or potentially future tutorials should cover two perspectives, clearly and intentionally:

  1. How you will write a tool to do the function covered in the tutorial (what we are doing now)
  2. How we use existing tools (XSLT implementation, oscal-cli metaschema subcommand, others TBD) that can curretly exercise that function/use case as a user without writing your own (we do not cover this yet)

@aj-stein-nist
Copy link
Collaborator Author

@david-waltermire-nist also asked for me in a call to do the following before asking for re-review:

  1. Add accordion style tab for instance examples in JSON, XML, YAML.
  2. Add tutorial landing page in place of this page in PR, move tutorial to its own page, link to the relocated tutorial on the new landing page

@aj-stein-nist aj-stein-nist force-pushed the 260-build-metaschema-level-1-capabilities-tutorial branch 2 times, most recently from 4fe822f to 53836c8 Compare January 6, 2023 22:11
@aj-stein-nist
Copy link
Collaborator Author

@david-waltermire-nist also asked for me in a call to do the following before asking for re-review:

1. Add accordion style tab for instance examples in JSON, XML, YAML.

2. Add tutorial landing page in place of this page in PR, move tutorial to its own page, link to the relocated tutorial on the new landing page

Ok @david-waltermire-nist, done and ready for review.

@aj-stein-nist
Copy link
Collaborator Author

The build failure, FYI, is waiting on #278 to build successfully in main.

@aj-stein-nist aj-stein-nist force-pushed the 260-build-metaschema-level-1-capabilities-tutorial branch 2 times, most recently from 53836c8 to d68c40e Compare January 9, 2023 15:43
Copy link
Collaborator

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

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

Looking good! Thanks AJ!

@wendellpiez wendellpiez self-requested a review January 9, 2023 20:37
Copy link
Collaborator

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

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

Mostly suggesting corrections to typos with a couple more substantial offerings.

Bravo AJ!

website/content/tutorials/1-getting-started/_index.md Outdated Show resolved Hide resolved
website/content/tutorials/1-getting-started/_index.md Outdated Show resolved Hide resolved
website/content/tutorials/1-getting-started/_index.md Outdated Show resolved Hide resolved
website/content/tutorials/1-getting-started/_index.md Outdated Show resolved Hide resolved
website/content/tutorials/1-getting-started/_index.md Outdated Show resolved Hide resolved
website/content/tutorials/1-getting-started/_index.md Outdated Show resolved Hide resolved
website/content/tutorials/1-getting-started/_index.md Outdated Show resolved Hide resolved
@aj-stein-nist aj-stein-nist mentioned this pull request Jan 11, 2023
5 tasks
@aj-stein-nist aj-stein-nist force-pushed the 260-build-metaschema-level-1-capabilities-tutorial branch from dbbd1ca to 9d851c2 Compare January 11, 2023 20:54
@aj-stein-nist aj-stein-nist force-pushed the 260-build-metaschema-level-1-capabilities-tutorial branch from 9d851c2 to 07044b0 Compare January 11, 2023 21:09
@aj-stein-nist
Copy link
Collaborator Author

@wendellpiez I included all the feedback you provided in your previous review. I will do a final pass for minor typos, but I need you, @david-waltermire-nist, or @nikitawootten-nist. I might find a typo or two, but it is ready to go.

@aj-stein-nist aj-stein-nist force-pushed the 260-build-metaschema-level-1-capabilities-tutorial branch from 07044b0 to 1636ada Compare January 11, 2023 22:34
Copy link
Collaborator

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

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

Went over this together looking good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Build Metaschema Level 1 Capabilities Tutorial
2 participants