UNCLASSIFIED - NO CUI

Skip to content

Docs update

Christopher McGrath requested to merge cmcgrath/template:docs_update into main

Feature Branch Preview:

https://repo1.dso.mil/cmcgrath/template/-/blob/docs_update/README.md

Changes:

  • Updated link to quickstart (was pointing at archived quickstart, now points to updated quickstart)
  • Improved gpg key creation command to work for gpg 2.0.x, 2.2.x, 2.3.x
  • Added sops tips and notes section:
    • preview https://repo1.dso.mil/cmcgrath/template/-/blob/docs_update/README.md#sops-tip-and-notes
    • Added how to use vs code / sublime to edit sops encrypted files + a note about how sops doesn't guarantee that yaml formatting will be preserved.
    • Removed a section called ## Key Vault, by absorbing it into the sops tips and notes section
    • Added a note to about GPG vs AGE, and how GPG should be preferred over AGE despite the sops repo saying otherwise, due to NIST approved algorithms.
    • Added a note about why CSP KMS should be preferred over GPG
    • Added a note that if FIPS 140-2 compliant Hashi Vault was desired then an HSM and enterprise license would be required as well.
  • Added a git repository recommendations section:

Merge request reports