Merge pull request #33 from shawndwells/master

Update Makefile, README
opencontrol · May 12, 2017 · 973fa72 · 973fa72
2 parents 711b220 + f4f53b0
commit 973fa72
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 9 deletions.
diff --git a/Makefile b/Makefile
@@ -22,7 +22,7 @@ clean:
 	- cd RHEL7 && make clean
 	- cd OpenShift-v3 && make clean
 
-rhel7: 
+rhel7: clean
 	- cd RHEL7 && make
 
 openshiftv3:

diff --git a/OpenShift-v3/Makefile b/OpenShift-v3/Makefile
@@ -16,7 +16,7 @@ EXECUTABLES = $(CM) $(GB)
 K := $(foreach exec,$(EXECUTABLES),\
         $(if $(shell which $(exec)),some string,$(error "No $(exec) in PATH")))
 
-default: pdf
+default: pdf fedramp
 
 clean:
 	rm -rf exports/ opencontrols/
@@ -36,11 +36,11 @@ opencontrols: opencontrol.yaml
 coverage:
 	${CM} diff FedRAMP-low
 
-fedramp: default
+fedramp:
 	${GOPATH}/bin/fedramp-templater fill opencontrols/ ../FedRAMP_Template/FedRAMP-System-Security-Plan-Template-v2.1.docx exports/FedRAMP-Filled-v2.1.docx
 
 fedramp-diff:
-	${GOPATH}/bin/fedramp-templater diff opencontrols/ FedRAMP_Template/FedRAMP-System-Security-Plan-Template-v2.1.docx
+	${GOPATH}/bin/fedramp-templater diff opencontrols/ ../FedRAMP_Template/FedRAMP-System-Security-Plan-Template-v2.1.docx
 
 checks:
 	yamllint policies/
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 OpenControl content for Red Hat technologies. Work in progress!
 
 
-## Building OpenControl/RedHat content
+## Prep your Development Environment
 A few packages are needed for successful OpenControl builds on a RHEL7 system. 
 
 (1) Install Base Packages
@@ -69,3 +69,15 @@ go get github.com/opencontrol/fedramp-templater
 `````
 sudo yum -y install yamllint
 `````
+
+## Build the Content
+You can run ``make`` in the top-level directory to build OpenControl content for all subprojects. Alternatively, you can ``cd`` into a project directory and run things one at a time.
+
+For example, to build OpenShift v3 content:
+`````
+$ cd OpenShift-v3
+$ make
+`````
+Inside the ``exports`` directory, you will now see two files:
+  * ``FedRAMP-Filled-v2.1.docx``: Completed FedRAMP template with your security controls
+  * ``OpenShift_v3_Compliance.pdf``: DocBook style, breakouts controls without formatting
diff --git a/RHEL7/Makefile b/RHEL7/Makefile
@@ -16,7 +16,7 @@ EXECUTABLES = $(CM) $(GB)
 K := $(foreach exec,$(EXECUTABLES),\
         $(if $(shell which $(exec)),some string,$(error "No $(exec) in PATH")))
 
-default: pdf
+default: pdf fedramp
 
 clean:
 	rm -rf exports/ opencontrols/
@@ -36,11 +36,11 @@ opencontrols: opencontrol.yaml
 coverage:
 	${CM} diff FedRAMP-low
 
-fedramp: default
-	${GOPATH}/bin/fedramp-templater fill opencontrols/ FedRAMP_Template/FedRAMP-System-Security-Plan-Template-v2.1.docx exports/FedRAMP-Filled-v2.1.docx
+fedramp: 
+	${GOPATH}/bin/fedramp-templater fill opencontrols/ ../FedRAMP_Template/FedRAMP-System-Security-Plan-Template-v2.1.docx exports/FedRAMP-Filled-v2.1.docx
 
 fedramp-diff:
-	${GOPATH}/bin/fedramp-templater diff opencontrols/ FedRAMP_Template/FedRAMP-System-Security-Plan-Template-v2.1.docx
+	${GOPATH}/bin/fedramp-templater diff opencontrols/ ../FedRAMP_Template/FedRAMP-System-Security-Plan-Template-v2.1.docx
 
 checks:
 	yamllint policies/