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

Add OSCAL Catalog and Profile Tutorials to Website #645

Closed
3 tasks done
david-waltermire opened this issue Apr 2, 2020 · 10 comments · Fixed by #1784
Closed
3 tasks done

Add OSCAL Catalog and Profile Tutorials to Website #645

david-waltermire opened this issue Apr 2, 2020 · 10 comments · Fixed by #1784
Assignees
Labels
enhancement Scope: Documentation This issue relates to OSCAL documentation. Scope: Website Issues targeted at the OSCAL project website. User Story

Comments

@david-waltermire
Copy link
Contributor

david-waltermire commented Apr 2, 2020

User Story:

As an OSCAL content creator, I need a set of tutorials that provide basic instruction on creating an OSCAL Catalog or Profile. I should be able to find these tutorials on the OSCAL website..

Goals:

This is a continuation of the work completed in issues #592 and #593.

The following work needs to be completed:

  1. Website modificiations:
    • The tutorials must be accessible using in "Tutorial" link in the main navigation.
    • The tutorial text needs to be edited to integrate code examples with the syntax highlighting provided by Hugo.
    • JSON and YAML examples need to be added to the existing XML examples.
  2. A Pull Request is submitted containing the above changes.

Dependencies:

None.

Acceptance Criteria

  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL 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.
@david-waltermire
Copy link
Contributor Author

This is being worked in PR #648.

At this point, the tutorials have been migrated into the website content folder, the main navigation is setup. Almost done adding JSON and YAML to the catalog tutorial

@david-waltermire david-waltermire added this to To do in Sprint 30 via automation May 7, 2020
@david-waltermire david-waltermire moved this from To do to In progress in Sprint 30 May 7, 2020
@david-waltermire david-waltermire removed this from In progress in Sprint 30 May 22, 2020
@david-waltermire david-waltermire added Scope: Documentation This issue relates to OSCAL documentation. Scope: Website Issues targeted at the OSCAL project website. labels Apr 13, 2021
@david-waltermire david-waltermire added this to To do in Sprint 41 via automation Apr 13, 2021
@david-waltermire david-waltermire removed this from To do in Sprint 41 May 13, 2021
@david-waltermire david-waltermire added this to To do in Sprint 42 via automation May 13, 2021
@david-waltermire david-waltermire moved this from To do to In progress in Sprint 42 May 13, 2021
@david-waltermire david-waltermire removed this from In progress in Sprint 42 Jun 10, 2021
@david-waltermire david-waltermire added this to To do in Sprint 44 via automation Jul 8, 2021
@david-waltermire david-waltermire removed this from To do in Sprint 44 Aug 5, 2021
@david-waltermire david-waltermire added this to To do in Sprint 45 via automation Aug 5, 2021
@david-waltermire david-waltermire added this to To do in Sprint 46 via automation Sep 9, 2021
@david-waltermire david-waltermire moved this from To do to In progress in Sprint 46 Sep 9, 2021
@david-waltermire david-waltermire added this to To do in Sprint 47 via automation Oct 7, 2021
@david-waltermire david-waltermire moved this from To do to In progress in Sprint 47 Oct 7, 2021
@david-waltermire david-waltermire added this to To do in Sprint 48 via automation Nov 4, 2021
@david-waltermire david-waltermire moved this from To do to In progress in Sprint 48 Nov 4, 2021
@david-waltermire david-waltermire removed this from In progress in Sprint 48 Dec 2, 2021
@david-waltermire david-waltermire removed this from the OSCAL 1.1.0 milestone Aug 25, 2022
@aj-stein-nist
Copy link
Contributor

As Dave has rolled of the project, I will re-assign this to myself in the interim until I can update it.

@aj-stein-nist
Copy link
Contributor

We are nearing the end of Sprint 64. I will leave this open for Sprint 65 and pick it up if there is no volunteer, we can pick it up in the second half of that sprint.

@aj-stein-nist aj-stein-nist removed their assignment Mar 16, 2023
@nikitawootten-nist
Copy link
Contributor

nikitawootten-nist commented Mar 20, 2023

It seems from the state of the catalog tutorial, the JSON and YAML examples for the catalog tutorial are finished, and the remaining work on this issue to create a basic profile tutorial.

I can try and pick this up this sprint.

Observed AC:

  • Minor fixes to the catalog tutorial (malformed JSON in this section)
  • Create a profile tutorial modeled after the catalog tutorial that:
    • Describes the OSCAL profile model, the act of profile resolution, and links to the relevant model docs and specs.
    • Builds a profile from scratch
    • Shows the resolved profile for each step

@aj-stein-nist
Copy link
Contributor

@nikitawootten-nist, @Arminta-Jenkins-NIST asked about this issue and she is interested in this as well. Can you two work together when you have a chance?

@aj-stein-nist
Copy link
Contributor

Team notified each other during standup today this likely will not get done before end of sprint today, will potentially opt to move forward and complete in Sprint 66.

@aj-stein-nist
Copy link
Contributor

@nikitawootten-nist can you please provide a status update for this on Monday so I can adjust for sprint wrap-up and reporting? Thank you!

@nikitawootten-nist
Copy link
Contributor

can you please provide a status update for this on Monday so I can adjust for sprint wrap-up and reporting? Thank you!

Hi all, the profile tutorial is in the process of being rewritten based on an example profile that builds off of the existing catalog tutorial. The progress of this issue can be found here: #1747.

As of now, all sections of the tutorial have been written except for sections pertaining to the "import" and "merge" phases, which is currently in progress.

@aj-stein-nist aj-stein-nist linked a pull request Apr 18, 2023 that will close this issue
14 tasks
@aj-stein-nist
Copy link
Contributor

@Arminta-Jenkins-NIST, I was under the impression you were working on part of this and we can review the work and resolve. Can we get a status update please?

@aj-stein-nist
Copy link
Contributor

Judging from what I had read and discussed with some of you yesterday, it seems this needs to be moved into Sprint 68.

@nikitawootten-nist nikitawootten-nist linked a pull request May 4, 2023 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Scope: Documentation This issue relates to OSCAL documentation. Scope: Website Issues targeted at the OSCAL project website. User Story
Projects
Status: Done
Sprint 29
  
In progress
Sprint 46
In progress
Sprint 47
In progress
5 participants