Skip to content

Commit

Permalink
Added note about gitter. More text around contributing (usnistgov#515)
Browse files Browse the repository at this point in the history
  • Loading branch information
david-waltermire authored Oct 17, 2019
1 parent d770a94 commit 7024120
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 32 deletions.
4 changes: 3 additions & 1 deletion docs/content/contribute/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ We use GitHub as a collaboration platform for the development of the OSCAL model

## Tools

All users but especially tool developers should consider reaching out and connecting with others using your technology stack or platform. See our [Resources page](/downloads/other-resources/) for more.
All users, but especially tool developers, should consider reaching out and connecting with others using your technology stack or platform. See our [resources page](/downloads/other-resources/) for more information.

You can connect with us and other developers working on OSCAL related projects on the [OSCAL Gitter](https://gitter.im/usnistgov-OSCAL/Lobby).

## Contact

Expand Down
6 changes: 4 additions & 2 deletions docs/content/contribute/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ title: Contact Us
description: Contact Us
---

Please email the [OSCAL team](mailto:[email protected]) with any questions you have about this project or if you are interested in getting involved.

Please visit our [GitHub repository](https://github.com/usnistgov/OSCAL) for more information, schemas, and examples.

You can chat with us directly on the [OSCAL Gitter](https://gitter.im/usnistgov-OSCAL/Lobby).

Please email the [OSCAL team](mailto:[email protected]) with any questions you have about this project or if you are interested in getting involved.

We also offer a couple of mailing lists.

- [[email protected]](mailto:[email protected]) for communication among parties interested in contributing to the development of OSCAL or exchanging ideas. Subscribe by sending an email to [[email protected]](mailto:[email protected]). To unsubscribe send an email to [[email protected]](mailto:[email protected]).
Expand Down
100 changes: 72 additions & 28 deletions docs/content/contribute/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,56 +2,100 @@
title: OSCAL Development Roadmap
aliases:
- /learnmore/roadmap/
sidenav:
collapseDepth: 3
---

OSCAL is a community-driven, NIST-led project, with an [open invitation](https://github.com/usnistgov/OSCAL/blob/master/CONTRIBUTING.md) to the community to participate in the framing and development of OSCAL. Feature requests can be [created and submitted](https://github.com/usnistgov/OSCAL/issues/new?assignees=&labels=User+Story%2C+enhancement&template=feature_request.md) directly into the project's GitHub repository. Feedback in the form of [bug reports](https://github.com/usnistgov/OSCAL/issues/new?assignees=&labels=bug&template=bug_report.md) are also encouraged and appreciated. If appropriate, we ask you add a comment to an [existing relevant issue](https://github.com/usnistgov/OSCAL/issues), and only create a new issue when no relevant issue exists. Before opening an issue, we ask that you review our [contributing guidelines](https://github.com/usnistgov/OSCAL/blob/master/CONTRIBUTING.md).

### Development Epics
# Development Epics

OSCAL is being designed and created over a series of development epics leveraging an incremental and agile approach. Each epic consists of a series of sprints focused on reaching a defined milestone. This approach allows the project team to provide increased value over time at an accelerated pace, by focusing on an 80% solution (Minimally Viable Product (MVP)) that can be implemented in 20% of the time.

Each [milestone](https://github.com/usnistgov/OSCAL/milestones) will result in an incremental release of OSCAL resources.

- OSCAL 1.0.0 [Milestone 1](https://github.com/usnistgov/OSCAL/milestone/1): Develop the OSCAL Catalog and Profile Models ([released](https://github.com/usnistgov/OSCAL/releases/tag/v1.0.0-milestone1))
## OSCAL v1

The initial OSCAL work encompasses the [catalog](/learnmore/architecture/catalog/) and [profile](/learnmore/architecture/profile/) concepts of the OSCAL [architecture](/learnmore/architecture/).
The first major version of OSCAL, OSCAL v1, will be developed over a series of milestone releases, culminating in a a [full release](#oscal-1-0-0-full-release) of OSCAL v1.

The following stakeholders can benefit from control catalogs and control baselines defined using the OSCAL catalog and profile models respectively.
### OSCAL 1.0.0 Milestone 1

- **Catalog maintainers:** Publishing control catalogs in OSCAL using OSCAL catalog XML, JSON, or YAML formats (e.g., NIST, ISO, ISACA)
- **Standard baseline maintainers:** Publishing control baselines using OSCAL profile XML, JSON, or YAML formats (e.g., NIST, FedRAMP), which can be used by many organizations consuming OSCAL formatted catalogs and baselines
- **Custom profile maintainers:** Developing new control baselines or customizing existing control baselines for organization-specific use (e.g., cloud service providers, integrators, agencies, businesses) using OSCAL profile XML, JSON, or YAML formats
- **Security and privacy personnel:** That need to select controls and implement security and privacy baselines to address security and privacy risks.
- **Tool vendors:** Creating tools that import and produce information in OSCAL formats to support risk assessment, continuous monitoring, compliance reporting, and other purposes
{{<tag class="">}}Development Milestone{{</tag>}} OSCAL 1.0.0 [Milestone 1](https://github.com/usnistgov/OSCAL/milestone/1)

- OSCAL 1.0.0 [Milestone 2](https://github.com/usnistgov/OSCAL/milestone/2): Develop the OSCAL System Security Plan (SSP) Model
{{<tag class="">}}Status{{</tag>}} [Released](https://github.com/usnistgov/OSCAL/releases/tag/v1.0.0-milestone1) (June 15, 2019)

This next phase of OSCAL work encompasses the SSP concepts that are part of the implementation layer of the OSCAL [architecture](/learnmore/architecture/). Updates to the catalog and profile models are also provided with this release.
{{<tag class="">}}Focus{{</tag>}} Development of the OSCAL Catalog and Profile Models.

The following additional stakeholders can benefit from SSPs formatted based on the OSCAL SSP model.
This initial OSCAL work encompasses the [catalog](/learnmore/architecture/catalog/) and [profile](/learnmore/architecture/profile/) concepts of the OSCAL [architecture](/learnmore/architecture/).

- **Security and privacy personnel:** Documenting system implementations, and automatically identifying and addressing security and privacy implementation gaps before loss or damage occur
- **Operations personnel:** Rapidly verifying that systems comply with organizational security requirements
- **Auditors/assessors:** Performing audits/assessments on demand with minimal effort based on rich OSCAL formatted system implementation information.
- **Policy personnel:** Identifying systemic problems that necessitate changes to organizational security policies
- **Tool vendors:** Creating tools that help organizations document and assess security and privacy control implementations using OSCAL formatted system implementation information to support risk assessment, continuous monitoring, compliance reporting, and other purposes
The following stakeholders can benefit from control catalogs and control baselines defined using the OSCAL catalog and profile models respectively.

- OSCAL 1.0.0 [Milestone 3](https://github.com/usnistgov/OSCAL/milestone/3): Develop the OSCAL Component Definition model
- **Catalog maintainers:** Publishing control catalogs in OSCAL using OSCAL catalog XML, JSON, or YAML formats (e.g., NIST, ISO, ISACA)
- **Standard baseline maintainers:** Publishing control baselines using OSCAL profile XML, JSON, or YAML formats (e.g., NIST, FedRAMP), which can be used by many organizations consuming OSCAL formatted catalogs and baselines
- **Custom profile maintainers:** Developing new control baselines or customizing existing control baselines for organization-specific use (e.g., cloud service providers, integrators, agencies, businesses) using OSCAL profile XML, JSON, or YAML formats
- **Security and privacy personnel:** That need to select controls and implement security and privacy baselines to address security and privacy risks.
- **Tool vendors:** Creating tools that import and produce information in OSCAL formats to support risk assessment, continuous monitoring, compliance reporting, and other purposes

This future phase of OSCAL work involves completing development of the OSCAL component definition model that is part of the implementation layer of the OSCAL [architecture](/learnmore/architecture/). Updates to the catalog, profile, and SSP models will also be provided with this release.
### OSCAL 1.0.0 Milestone 2

The following additional stakeholders can benefit from component definitions formatted based on the OSCAL component definitions model. They include the following producers of OSCAL catalogs, profiles, and/or tools:
{{<tag class="">}}Development Milestone{{</tag>}} OSCAL 1.0.0 [Milestone 1](https://github.com/usnistgov/OSCAL/milestone/2)

- **Security and privacy personnel:** Documenting system implementations can import component information related to hardware, software, services, policies, and procedures used to implement their systems saving time and effort
- **Policy personnel:** Can publish information about their policies as a component formatted using the OSCAL component definition model.
- **Tool vendors:** Creating tools that help organizations document and assess security and privacy control implementations using OSCAL formatted component and system implementation information to support risk assessment, continuous monitoring, compliance reporting, and other purposes
{{<tag class="">}}Status{{</tag>}} [Released](https://github.com/usnistgov/OSCAL/releases/tag/v1.0.0-milestone2) (October 1, 2019)

- OSCAL 1.0.0 [Final Release](https://github.com/usnistgov/OSCAL/milestone/4): Publish an OSCAL 1.0.0 Specification
{{<tag class="">}}Focus{{</tag>}} Development of the OSCAL System Security Plan (SSP) Model.

To accelerate the development of OSCAL, we are not focused on developing a formal specification for OSCAL until the final OSCAL 1.0.0 milestone. Until then, the OSCAL models are be [documented](/documentation/schema/) on this site. This will allow us to work on a formal specification once most of the major development of OSCAL is completed. Until that point, adopters of OSCAL will find all of the resources they need to develop content and tools on this site.
This next phase of OSCAL work encompasses the SSP concepts that are part of the implementation layer of the OSCAL [architecture](/learnmore/architecture/). Updates to the catalog and profile models are also provided with this release.

- OSCAL 2.0.0 [2.0.0](https://github.com/usnistgov/OSCAL/milestone/5): Develop OSCAL 2.0.0
The following additional stakeholders can benefit from SSPs formatted based on the OSCAL SSP model.

The OSCAL Assessment and Assessment Results models will be developed as part of the OSCAL 2.0.0 release. This development will address the Assessment and Assessment Results layers of the OSCAL [architecture](/learnmore/architecture/).
- **Security and privacy personnel:** Documenting system implementations, and automatically identifying and addressing security and privacy implementation gaps before loss or damage occur
- **Operations personnel:** Rapidly verifying that systems comply with organizational security requirements
- **Auditors/assessors:** Performing audits/assessments on demand with minimal effort based on rich OSCAL formatted system implementation information.
- **Policy personnel:** Identifying systemic problems that necessitate changes to organizational security policies
- **Tool vendors:** Creating tools that help organizations document and assess security and privacy control implementations using OSCAL formatted system implementation information to support risk assessment, continuous monitoring, compliance reporting, and other purposes

This assessment work has been split from the earlier OSCAL work to allow a stable version of OSCAL formats to be released and maintained that provide a solid foundation for publishing control catalog and baseline information, and to allow organizations to automate the documentation and maintenance of system implementations. This will allow tool vendors to develop against stable OSCAL 1.0 releases, while ongoing development of OSCAL continues.
### OSCAL 1.0.0 Milestone 3

{{<tag class="">}}Development Milestone{{</tag>}} OSCAL 1.0.0 [Milestone 3](https://github.com/usnistgov/OSCAL/milestone/3)

{{<tag class="">}}Status{{</tag>}} [Under development](https://github.com/usnistgov/OSCAL/)

{{<tag class="">}}Focus{{</tag>}} Development of the OSCAL Component Definition model.

This current phase of OSCAL work involves completing development of the OSCAL component definition model that is part of the implementation layer of the OSCAL [architecture](/learnmore/architecture/). Updates to the catalog, profile, and SSP models will also be provided with this release.

The following additional stakeholders can benefit from component definitions formatted based on the OSCAL component definitions model. They include the following producers of OSCAL catalogs, profiles, and/or tools:

- **Security and privacy personnel:** Documenting system implementations can import component information related to hardware, software, services, policies, and procedures used to implement their systems saving time and effort
- **Policy personnel:** Can publish information about their policies as a component formatted using the OSCAL component definition model.
- **Tool vendors:** Creating tools that help organizations document and assess security and privacy control implementations using OSCAL formatted component and system implementation information to support risk assessment, continuous monitoring, compliance reporting, and other purposes

### OSCAL 1.0.0 Full Release

{{<tag class="">}}Development Milestone{{</tag>}} OSCAL 1.0.0 [Full Release](https://github.com/usnistgov/OSCAL/milestone/4)

{{<tag class="">}}Status{{</tag>}} Planned

{{<tag class="">}}Focus{{</tag>}} Publish an OSCAL 1.0.0 Specification

To accelerate the development of OSCAL, we are not focused on developing a formal specification for OSCAL until the final OSCAL 1.0.0 milestone. Until then, the OSCAL models are [documented](/documentation/schema/) on this site. This will allow us to work on a formal specification once most of the major development of OSCAL is completed. For now, adopters of OSCAL will find all of the resources they need to develop content and tools on this site.

### Beyond the OSCAL 1.0.0 Full Release

We will continue to address any defects, improve documentation, and add features where possible over a series of minor and defect fix releases. Minor releases will be be indicated as `1.x.0`, where `x` will be incremented for each minor release. This may include backporting features being worked on in the OSCAL 2.0.0 release epics. Defect fix releases will be indicated as `1.x.y`, where `x` will be the current minor release and `y` will be incremented for each defect fix release. This will allow adopters to benefit from releases against a stable and supported OSCAL v1, while we work on significant new features in OSCAL v2.

## OSCAL v2

Similar to OSCAL v1, the second major version of OSCAL, OSCAL v2, will be developed over a series of milestone releases. We have not yet planned a specific number of milestones in the OSCAL v2 epic. We will start planning OSCAL v2 as are near wrapping up the [final development milestone](#oscal-1-0-0-full-release) of OSCAL v1.

### OSCAL 2.0.0 Milestone 1

{{<tag class="">}}Development Milestone{{</tag>}} OSCAL 2.0.0 [Milestone 1](https://github.com/usnistgov/OSCAL/milestone/5)

{{<tag class="">}}Status{{</tag>}} Planned

{{<tag class="">}}Focus{{</tag>}} Develop the OSCAL Assessment and Assessment Results models.

The OSCAL Assessment and Assessment Results models will be developed as part of the OSCAL 2.0.0 release. This development will address the Assessment and Assessment Results layers of the OSCAL [architecture](/learnmore/architecture/).

This assessment work has been split from the earlier OSCAL v1 epic to allow a stable version of OSCAL formats to be released and maintained that provide a solid foundation for publishing control catalog and baseline information, and to allow organizations to automate the documentation and maintenance of system implementations. This will allow tool vendors to develop against stable OSCAL v1 releases, while ongoing development of OSCAL v2 continues.
2 changes: 2 additions & 0 deletions docs/content/downloads/other-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ aliases:

* [OSCALkit - Converts XML -> JSON (and vice versa)](https://github.com/docker/oscalkit)

If you have a tool that supports the OSCAL formats that you would like to have listed here, please [contact us](/contribute/contact/).

## Videos and Presentations

* [Security Automation Simplified via NIST OSCAL: We're Not in Kansas Anymore](https://www.youtube.com/watch?v=eP8K7piU5UQ)
Expand Down
2 changes: 1 addition & 1 deletion docs/themes/uswds

0 comments on commit 7024120

Please sign in to comment.