Apply repository changes described in ADR-007

[Rene2mt]

This is a ...

improvement - something could be better

This relates to ...

• [ ] the FedRAMP OSCAL Registry
• [ ] the FedRAMP OSCAL baselines
• [ ] the Guide to OSCAL-based FedRAMP Content
• [ ] the Guide to OSCAL-based FedRAMP System Security Plans (SSP)
• [ ] the Guide to OSCAL-based FedRAMP Security Assessment Plans (SAP)
• [ ] the Guide to OSCAL-based FedRAMP Security Assessment Results (SAR)
• [ ] the Guide to OSCAL-based FedRAMP Plan of Action and Milestones (POA&M)
• [ ] the FedRAMP SSP OSCAL Template (JSON or XML Format)
• [ ] the FedRAMP SAP OSCAL Template (JSON or XML Format)
• [ ] the FedRAMP SAR OSCAL Template (JSON or XML Format)
• [ ] the FedRAMP POA&M OSCAL Template (JSON or XML Format)
• [ ] the FedRAMP OSCAL Validations

User Story

As a FedRAMP automation stakeholder, I need the repository to know if parts of the codebase are obsolete, deprecated and/or no longer maintained, so that I do not use code/tools/resources that are no longer supported and can find the current / active resources more easily.

Goals

Per ADR-007:

• [ ] dist/content/rev4

  • [ ] Add README - FR has transitioned to Rev 5. Rev 4 baselines, resources, and templates are no longer maintained but will be kept frozen for historical purposes.
  • [ ] Mark as DEPRECATED

• [ ] dist/content/rev5/resources

  • [ ] Archive README - letting community know FedRAMP is transitioning from fedramp_extensions.xml & fedramp_values.json

    • [ ] FedRAMP to consider future work on replacing them with report of constraints auto-generated by CI or OSCAL-CLI (from Metaschema constraints)

• [ ] dist/content/rev5/templates

  • [ ] Update README clarifying intent of FedRAMP “template” and documenting known validation issues with each template. Where possilbe, FedRAMP will attempt to fix template validation issues to reduce the amount of errors they produce.

• [ ] documents folder

  • [ ] Update README sending community to https://automate.fedramp.gov/ for documentation going forward. Add statement about PDF guides no longer being maintained and that existing GH issues submitted about the guides will be address via updates to https://automate.fedramp.gov/

    • [ ] documents/rev4/README.md - mark as OBSOLETE and remove PDF guides
    • [ ] documents/rev5/README.md - mark as OBSOLETE and remove PDF guides

• [ ] presentations folder

  • [ ] presentations/data-bites

    • [ ] Move to automte.fedramp.gov and update with latest Data Bites slides

  • [ ] Add presentations/oscal-implementers folder in the automate.fedramp.gov repository

    • [ ] Update with latest OSCAL Implementers slides

• [ ] src/examples/README.md - ARCHIVED

  • [ ] Delete all current contents

• [ ] src/utils/extensions-preview.xsl - ARCHIVED

  • [ ] Delete all current contents

• [ ] validations folder - ARCHIVED

  • [ ] Delete all current contents
  • [ ] Update the README to let community know this is now archived and no longer maintained

• [ ] validations/constraints - Plan on adding new validation constraints and associated documentation that is currently in the feature/external-extensions branch.

  • [ ] Once merged from that feature branch and a release is created, it will be available in the master branch for the community.

Dependencies

No response

Acceptance Criteria

• All FedRAMP Documents Related to OSCAL Adoption (https://github.com/GSA/fedramp-automation) affected by the changes in this issue have been updated.
• A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.

Other information

No response

[aj-stein-gsa]

@Rene2mt, just a heads up that I merged the #645 ADR we should move forward with the minor release with deprecation notices by the end of this week or beginning of next week. Do you want to take point on this work, me, or both of us? Let me know, I can adjust accordingly.

[Rene2mt]

Awesome!!! I can start on that tomorrow (issue #670)