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

Create Releases Page #26

Open
Rene2mt opened this issue Jun 26, 2024 · 1 comment
Open

Create Releases Page #26

Rene2mt opened this issue Jun 26, 2024 · 1 comment

Comments

@Rene2mt
Copy link
Member

Rene2mt commented Jun 26, 2024

Create a releases page that will be referenced throughout the documentation. The releases page will provide consolidated links to various referenced GitHub resources that are currently referenced in the documentation. This will simplify maintenance of links (to referenced GitHub resources) when new releases are made available.

The following is a list of documentation references to OSCAL GitHub resources:

content\documentation\general-concepts\oscal-file-concepts.md:
  273  To ensure stable resources, use a formal OSCAL release. NIST publishes formal OSCAL releases here:
  274: https://github.com/usnistgov/OSCAL/releases
  275  {{</callout>}}

content\documentation\general-concepts\profile-resolution.md:
  69  
  70: <https://github.com/usnistgov/OSCAL/tree/main/src/specifications/profile-resolution>
  71  

  73  
  74: <https://github.com/usnistgov/OSCAL/tree/v1.1.2/src/utils/resolver-pipeline>
  75  

  90  
  91: <https://github.com/usnistgov/OSCAL/blob/v1.1.2/src/utils/resolver-pipeline/oscal-profile-RESOLVE.xsl>
  92  

  96  
  97: <https://github.com/usnistgov/OSCAL/issues>

content\resources\_index.md:
  15  - Learning Resources: https://pages.nist.gov/OSCAL/learn/
  16: - Current release: https://github.com/usnistgov/OSCAL/releases  
  17: - Development version: https://github.com/usnistgov/OSCAL/tree/develop 
  18  - Content repo: https://github.com/usnistgov/oscal-content 

The following is a list of documentation references to fedramp-automation GitHub resources:

content\documentation\_index.md:
  62  
  63: - [https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/templates](https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/templates)
  64  

content\documentation\general-concepts\3-fedramp-extensions-and-accepted-values.md:
  126  _***Revised FedRAMP Registry Approach***<br/>The FedRAMP OSCAL Registry was originally provided as a spreadsheet. It now uses the draft OSCAL Extensions syntax and is offered in XML and JSON formats._
  127: - _[XML Version](https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/resources/xml/FedRAMP_extensions.xml)_
  128  - _[JSON Version](https://raw.githubusercontent.com/GSA/fedramp-automation/master/dist/content/rev5/resources/json/FedRAMP_extensions.json)_

  179  
  180: - _[XML Version](https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/resources/xml/FedRAMP_extensions.xml)_
  181  - _[JSON Version](https://raw.githubusercontent.com/GSA/fedramp-automation/master/dist/content/rev5/resources/json/FedRAMP_extensions.json)_

content\documentation\general-concepts\oscal-based-baselines.md:
  74  will be located here:\
  75: <https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/baselines>
  76  

content\documentation\general-concepts\oscal-file-concepts.md:
  170  
  171: [https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/templates](https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/templates)
  172  

  214  OSCAL supported by baselines, templates, documentation, and ancillary
  215: utilities. See [the OSCAL Support and Deprecation Policy in the FedRAMP Automation Github repository](https://github.com/GSA/fedramp-automation/blob/e0bf4d343b8bd06daa52e7817b2215f294aeab6b/README.md#support-and-oscal-deprecation-strategy) for further details.
  216  

content\documentation\poam\3-working-with-oscal-files.md:
  44  -   OSCAL-based FedRAMP POA&M Template (JSON Format):\
  45:     <https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/poam/json/FedRAMP-POAM-OSCAL-Template.json>
  46  
  47  -   OSCAL-based FedRAMP POA&M Template (XML Format):\
  48:     <https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/poam/xml/FedRAMP-POAM-OSCAL-Template.xml>
  49  

content\documentation\sap\3-working-with-oscal-files.md:
  63  -   OSCAL-based FedRAMP SAP Template (JSON Format):\
  64:     [https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/sap/json/FedRAMP-SAP-OSCAL-Template.json](https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/sap/json/FedRAMP-SAP-OSCAL-Template.json)
  65  
  66  -   OSCAL-based FedRAMP SAP Template (XML Format):\
  67:     [https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/sap/xml/FedRAMP-SAP-OSCAL-Template.xml](https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/sap/xml/FedRAMP-SAP-OSCAL-Template.xml)
  68  

content\documentation\sap\4-sap-template-to-oscal-mapping.md:
  1591  from the test case workbook are now part of the [OSCAL-based FedRAMP
  1592: baselines](https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/baselines),
  1593  with the detail imported from the OSCAL-based NIST SP 800-53 Catalog via

content\documentation\sap\5-generated-content.md:
  27  
  28: [https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/resources](https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/resources)
  29  

content\documentation\sar\3-working-with-oscal-files.md:
  135  -   OSCAL-based FedRAMP SAR Template (JSON Format):\
  136:     [https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/sar/json/FedRAMP-SAR-OSCAL-Template.json](https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/sar/json/FedRAMP-SAR-OSCAL-Template.json)
  137  
  138  -   OSCAL-based FedRAMP SAR Template (XML Format):\
  139:     [https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/sar/xml/FedRAMP-SAR-OSCAL-Template.xml](https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/sar/xml/FedRAMP-SAR-OSCAL-Template.xml)
  140  

content\documentation\sar\4-sar-template-to-oscal-mapping.md:
  32  _***Revised FedRAMP Registry Approach***<br/>The FedRAMP OSCAL Registry was originally provided as a spreadsheet. It now uses the draft OSCAL Extensions syntax and is offered in XML and JSON formats._
  33: - _[XML Version](https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/resources/xml/FedRAMP_extensions.xml)_
  34  - _[JSON Version](https://raw.githubusercontent.com/GSA/fedramp-automation/master/dist/content/rev5/resources/json/FedRAMP_extensions.json)_

content\documentation\sar\5-generated-content.md:
  38  
  39: [https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/resources](https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/resources)
  40  

content\documentation\ssp\3-working-with-oscal-files.md:
   46  -   OSCAL-based FedRAMP SSP Template (JSON Format):\
   47:     [https://github.com/GSA/fedramp-automation/raw/master/dist/rev5/content/rev5/templates/ssp/json/FedRAMP-SSP-OSCAL-Template.json](https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/ssp/json/FedRAMP-SSP-OSCAL-Template.json)
   48  
   49  -   OSCAL-based FedRAMP SSP Template (XML Format):\
   50:     <https://github.com/GSA/fedramp-automation/raw/master/dist/content/rev5/templates/ssp/xml/FedRAMP-SSP-OSCAL-Template.xml>
   51  

  111  
  112: Note: Cloud Service Providers must import [FedRAMP profiles or resolved profile catalogs](https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/baselines).
  113  

content\documentation\ssp\7-generated-content.md:
  19  
  20: <https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/resources>
  21  

content\start\_index.md:
  68  **Example: Creating a FedRAMP SSP**
  69: 1. Copy [template SSP](https://github.com/GSA/fedramp-automation/tree/master/dist/content/rev5/templates/ssp) from the repository.
  70  2. Modify the copied file to include your system characteristics, system implementation details, and control implementations.

  86  - Attend a FedRAMP [OSCAL Data Bites session](/resources/#data-bites).
  87: - Ask questions at [https://github.com/GSA/fedramp-automation/issues](https://github.com/GSA/fedramp-automation/issues).
  88  - Email us at [email protected].
@aj-stein-gsa
Copy link
Contributor

aj-stein-gsa commented Oct 25, 2024

I think we ought to talk about this issue in relation to GSA/fedramp-automation#738, @Rene2mt.

@aj-stein-gsa aj-stein-gsa moved this from 📋 Backlog to 🔖 Ready in FedRAMP Automation Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🔖 Ready
Development

No branches or pull requests

2 participants