updating docs readme and adding known issues

vmware · Jul 6, 2023 · 7b9360d · 7b9360d
1 parent a198d0b
commit 7b9360d
Show file tree

Hide file tree

Showing 11 changed files with 66 additions and 8 deletions.
diff --git a/nsx/4.x/docs/README.md b/nsx/4.x/docs/README.md
@@ -3,4 +3,7 @@
 ## Overview
 An XCCDF formatted XML is provided for the NSX 4.x STIG Readiness Guide content for use to view in [STIG Viewer](https://public.cyber.mil/stigs/stig-viewing-tools/).  
 
-This can consumed from the zip file included here or from the individual files themselves.
+This can consumed from the zip file included in the [VMware NSX 4.x STIG Readiness Guide Documentation](https://core.vmware.com/resource/vmware-nsx-4x-stig-readiness-guide).  
+
+## Known Issues
+Any known issues will be documented in the known-issues.md document located here.  
diff --git a/nsx/4.x/docs/U_VMware_NSX_4.x_STIG_Readiness_Guide_v1r1.zip b/nsx/4.x/docs/U_VMware_NSX_4.x_STIG_Readiness_Guide_v1r1.zip
diff --git a/nsx/4.x/docs/known-issues.md b/nsx/4.x/docs/known-issues.md
@@ -0,0 +1,19 @@
+# Table of contents
+
+# Known Issues
+
+This document outlines known issues with the NSX 4.x STIG Readiness Guide content, including workarounds if known.
+
+## What should I do if...
+
+### I have additional questions about an issue listed here?
+
+Each known issue links off to an existing GitHub issue. If you have additional questions or feedback, please comment on the issue.
+
+### My issue is not listed here?
+
+Please check the [open](https://github.com/vmware/dod-compliance-and-automation/issues) and [closed](https://github.com/vmware/dod-compliance-and-automation/issues?q=is%3Aissue+is%3Aclosed) issues in the issue tracker for the details of your bug. If you can't find it, or if you're not sure, open a new issue.
+
+## NSX Manager
+
+No known issues at this time.  
diff --git a/vcf/4.x/docs/README.md b/vcf/4.x/docs/README.md
@@ -3,4 +3,7 @@
 ## Overview
 XCCDF formatted XML files are provided for the VMware Cloud Foundation 4.x STIG Readiness Guide content for use to view in [STIG Viewer](https://public.cyber.mil/stigs/stig-viewing-tools/).  
 
-This can consumed from the zip file included in the [VMware Cloud Foundation 4.x Documentation](https://core.vmware.com/resource/vmware-cloud-foundation-45-stig-readiness-guide).  
+This can consumed from the zip file included in the [VMware Cloud Foundation 4.x STIG Readiness Guide](https://core.vmware.com/resource/vmware-cloud-foundation-45-stig-readiness-guide).  
+
+## Known Issues
+Any known issues will be documented in the known-issues.md document located here.  
diff --git a/vcf/4.x/docs/known-issues.md b/vcf/4.x/docs/known-issues.md
@@ -0,0 +1,19 @@
+# Table of contents
+
+# Known Issues
+
+This document outlines known issues with the VCF 4.x STIG Readiness Guide content, including workarounds if known.
+
+## What should I do if...
+
+### I have additional questions about an issue listed here?
+
+Each known issue links off to an existing GitHub issue. If you have additional questions or feedback, please comment on the issue.
+
+### My issue is not listed here?
+
+Please check the [open](https://github.com/vmware/dod-compliance-and-automation/issues) and [closed](https://github.com/vmware/dod-compliance-and-automation/issues?q=is%3Aissue+is%3Aclosed) issues in the issue tracker for the details of your bug. If you can't find it, or if you're not sure, open a new issue.
+
+## SDDC Manager
+
+No known issues at this time.  
diff --git a/vcf/5.x/docs/README.md b/vcf/5.x/docs/README.md
@@ -3,4 +3,7 @@
 ## Overview
 XCCDF formatted XML files are provided for the VMware Cloud Foundation 5.x STIG Readiness Guide content for use to view in [STIG Viewer](https://public.cyber.mil/stigs/stig-viewing-tools/).  
 
-This can consumed from the zip file included in the [VMware Cloud Foundation 5.x Documentation](https://core.vmware.com/resource/vmware-cloud-foundation-50-stig-readiness-guide).  
+This can consumed from the zip file included in the [VMware Cloud Foundation 5.x STIG Readiness Guide](https://core.vmware.com/resource/vmware-cloud-foundation-50-stig-readiness-guide).  
+
+## Known Issues
+Any known issues will be documented in the known-issues.md document located here.  
diff --git a/vcf/5.x/docs/known-issues.md b/vcf/5.x/docs/known-issues.md
@@ -2,7 +2,7 @@
 
 # Known Issues
 
-This document outlines known issues with the vSphere 7 STIG content, including workarounds if known.
+This document outlines known issues with the VCF 5.x STIG Readiness Guide content, including workarounds if known.
 
 ## What should I do if...
 

diff --git a/vsphere/6.7/docs/README.md b/vsphere/6.7/docs/README.md
@@ -1 +1,6 @@
-The 6.7 STIG is published now so the documentation is now available on public.cyber.mil
+# VMware vSphere 6.7 STIG Documentation
+
+## Overview
+An XCCDF formatted XML is provided for the vSphere 6.7 STIG content for each component for use to view in [STIG Viewer](https://public.cyber.mil/stigs/stig-viewing-tools/).  
+
+This can consumed from the latest download available at [public.cyber.mil](https://public.cyber.mil/stigs/downloads/).
diff --git a/vsphere/7.0/docs/README.md b/vsphere/7.0/docs/README.md
@@ -1,6 +1,9 @@
 # VMware vSphere 7.0 STIG Documentation
 
 ## Overview
-An XCCDF formatted XML is provided for the vSphere 7.0 STIG Readiness Guide content for each component for use to view in [STIG Viewer](https://public.cyber.mil/stigs/stig-viewing-tools/).  
+An XCCDF formatted XML is provided for the vSphere 7.0 STIG content for each component for use to view in [STIG Viewer](https://public.cyber.mil/stigs/stig-viewing-tools/).  
 
-The zip file here can be directly imported into STIG Viewer for review and checklist creation.
+This can consumed from the latest download available at [public.cyber.mil](https://public.cyber.mil/stigs/downloads/).
+
+## Known Issues
+Any known issues will be documented in the known-issues.md document located here.  
diff --git a/vsphere/7.0/docs/U_VMware_vSphere_7.0_STIG_Readiness_Guide_v1r4.zip b/vsphere/7.0/docs/U_VMware_vSphere_7.0_STIG_Readiness_Guide_v1r4.zip
diff --git a/vsphere/8.0/docs/README.md b/vsphere/8.0/docs/README.md
@@ -3,4 +3,7 @@
 ## Overview
 An XCCDF formatted XML is provided for the vSphere 8 STIG Readiness Guide content for each component for use to view in [STIG Viewer](https://public.cyber.mil/stigs/stig-viewing-tools/).  
 
-The zip file here can be directly imported into STIG Viewer for review and checklist creation.
+This can consumed from the zip file included in the [VMware vSphere 8 STIG Readiness Guide](https://core.vmware.com/resource/vmware-vsphere-8-stig-readiness-guide).  
+
+## Known Issues
+Any known issues will be documented in the known-issues.md document located here.