From 1e60bcc5f9790ae381cae4ef7d3abff396b88045 Mon Sep 17 00:00:00 2001 From: "A.J. Stein" Date: Tue, 19 Sep 2023 17:31:43 -0400 Subject: [PATCH] Add blog index section and introductory post (#44) * Add blog section index. * Add edited blog post for usnistgov/OSCAL#1911. Co-authored-by: Arminta Jenkins Co-authored-by: Michaela Iorga Co-authored-by: Wendell Piez * PR feedback: correct blog index heading. * PR feedback: shorten title, stick to fall cleaning. * PR feedback: community->all, all is confusing. * PR feedback: switch from deep to fall cleaning in 1st para. * PR feedback: update changes list to include XSLT converter artifact summary, as requested. * PR feedback: add summary about oscal-tools and oscal-cat As requested, do this so that the distinction between release artifacts, what metaschema-xslt does, and what higher-level transformations that were in oscal-tools is more clear. * Take Nikita's feedback on changes list Take feedback with wording improvements and mentioning of a simpler build process. Co-authored-by: Nikita Wootten * PR feedback: remove contraction. * PR feedback: add mention of v1.1.1 also. * PR feedback: be explicit and repeat mention of OSCAL repo Remove more casual language that was not concise enough. --------- Co-authored-by: Arminta Jenkins Co-authored-by: Wendell Piez Co-authored-by: Nikita Wootten --- src/content/about/blog/_index.md | 7 ++++++ .../about/blog/oscal-first-deep-cleaning.md | 22 +++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 src/content/about/blog/_index.md create mode 100644 src/content/about/blog/oscal-first-deep-cleaning.md diff --git a/src/content/about/blog/_index.md b/src/content/about/blog/_index.md new file mode 100644 index 00000000..cbc93c76 --- /dev/null +++ b/src/content/about/blog/_index.md @@ -0,0 +1,7 @@ +--- +title: OSCAL Blog +heading: Blog +description: Blog posts from staff and community about OSCAL. +toc: + enabled: true +--- \ No newline at end of file diff --git a/src/content/about/blog/oscal-first-deep-cleaning.md b/src/content/about/blog/oscal-first-deep-cleaning.md new file mode 100644 index 00000000..4ab41760 --- /dev/null +++ b/src/content/about/blog/oscal-first-deep-cleaning.md @@ -0,0 +1,22 @@ +--- +title: OSCAL's Fall Cleaning +--- + +Welcome to the Open Security Controls Assessment Language (OSCAL) Blog, open to the NIST OSCAL Team and to the community! + +If you work closely with us, you might have noticed we finished [a large code repository reorganization](https://github.com/usnistgov/OSCAL/blob/f24dd56d5569ade8489924cf6fc2640dc297bfbe/decisions/0005-repository-reorganization.md) alongside [the release of OSCAL v1.1.0](https://github.com/usnistgov/OSCAL/releases/tag/v1.1.0) and the subsequent [OSCAL v1.1.1 release] (https://github.com/usnistgov/OSCAL/releases/tag/v1.1.1). The OSCAL Project was in a desperate need of some internal restructuring, a fall cleaning of sorts. As an OSCAL user, the differences should not affect affect you, but we will still summarize some key changes for you. + +One may wonder why we reorganized our code repos only recently. Our answer is simple: we started small (more than six years ago!) and wanted to keep everything in one place to reduce the maintenance overhead. As we expanded our work, we needed to separate code repos to get better organized. + +Here is what changed: + +- The OSCAL website's source code (known as OSCAL pages) moved to its own repo, [OSCAL-Pages](https://github.com/usnistgov/OSCAL-Pages). +- The OSCAL reference documentation's source code moved to its own repo, [OSCAL-Reference](https://github.com/usnistgov/OSCAL-Reference). +- The Metaschema tooling's source code, which we use to process OSCAL models and generate documentation, moved to its own repo, [metaschema-xslt](https://github.com/usnistgov/metaschema-xslt). +- The generated JSON and XML schemas for the models and converters for JSON-XML and XML-JSON conversion are only [published as part of releases](https://github.com/usnistgov/OSCAL/releases), they are not saved in the [OSCAL repo](https://github.com/usnistgov/OSCAL/) like source code anymore. We also [simplified the build process](https://github.com/usnistgov/OSCAL/blob/main/build/README.md), making it easier for community members to prototype and propose changes to the OSCAL models. + +The NIST OSCAL Team officially maintains those new repos in addition to the existing [OSCAL](https://github.com/usnistgov/OSCAL/), [oscal-content](https://github.com/usnistgov/oscal-content/), [liboscal-java](https://github.com/usnistgov/liboscal-java/), and [oscal-cli](https://github.com/usnistgov/oscal-cli/) repos. As priorities shifted, we have paused development on [oscal-cat, the catalog authoring tool](https://github.com/usnistgov/oscal-cat), and [oscal-tools, a library of XSLT transformations for OSCAL developer use cases](https://github.com/usnistgov/oscal-tools). Those projects are archived and remain available for reference and demonstration. + +For an up-to-date description of all projects and their relationship to one another, please take a moment and review the [OSCAL project structure](https://pages.nist.gov/OSCAL/about/projects/) on our website. + +Moving forward, the NIST team will author future blog posts as needed. If you have an OSCAL topic you would like to read about or you want to guest-author a blog, you can email the [NIST OSCAL team](mailto:oscal@nist.gov?subject=NIST%20Blog) your proposal and the team will work with you to approve and post the blog. \ No newline at end of file