Updated README.md, SECURITY.md and OSS Docs Structure (#124)

* Updated README.md with open source instructions, moving items to the correct places. Co-authored-by: Dave McAllister <[email protected]> Co-authored-by: Jon Cahill-Torre <[email protected]> Co-authored-by: Jcahilltorre <[email protected]> Co-authored-by: o.omahony <[email protected]> Co-authored-by: oCHRISo <[email protected]>
nginx · Nov 30, 2022 · 536bf7c · 536bf7c
1 parent 62054d1
commit 536bf7c
Show file tree

Hide file tree

Showing 9 changed files with 237 additions and 101 deletions.
diff --git a/docs/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.md
diff --git a/docs/CONTRIBUTING.md → CONTRIBUTING.md b/docs/CONTRIBUTING.md → CONTRIBUTING.md
diff --git a/README.md b/README.md
diff --git a/docs/SECURITY.md → SECURITY.md b/docs/SECURITY.md → SECURITY.md
@@ -1,8 +1,8 @@
 # Security Policy
 
-## Supported Versions
+## Latest Versions
 
-We advise users to run the most recent release and/or stable commit of the NGINX Agent, and we issue software updates to the most recent release. We provide technical support for F5 customers who are using the most recent version of the NGINX Agent, and any version released within two years of the current release.
+We advise users to run or update to the most recent release of the NGINX Agent. Older versions of the NGINX Agent may not have all enhancements and/or bug fixes applied to them.
 
 ## Reporting a Vulnerability
 
@@ -11,4 +11,4 @@ The F5 Security Incident Response Team (F5 SIRT) has an email alias that makes i
 * If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support).
 * If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities with any F5 product to the F5 Security Incident Response Team at [email protected]
 
-For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability)
+For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability)
diff --git a/docs/agent-banner.png b/docs/agent-banner.png
diff --git a/docs/agent-flow.png b/docs/agent-flow.png
diff --git a/docs/grafana-dashboard-example.png b/docs/grafana-dashboard-example.png
diff --git a/docs/how-it-works.png b/docs/how-it-works.png
diff --git a/sdk/examples/server.go b/sdk/examples/server.go
@@ -50,7 +50,7 @@ func main() {
 
 	//Serve gRPC Server
 	log.Println("http listening")
-	log.Println("grpc listening")
+	log.Println("gRPC listening")
 
 	go func() {
 		if err := grpcServer.Serve(grpcListener); err != nil {
@@ -60,7 +60,7 @@ func main() {
 
 	http.Handle("/", http.FileServer(http.FS(content)))
 
-	http.Handle("/registered", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
+	http.Handle("/registered/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
 		payload, err := json.Marshal(commandService.GetRegistration())
 		if err != nil {
 			log.Warnf("%v", err)
@@ -69,7 +69,7 @@ func main() {
 		rw.Write(payload)
 	}))
 
-	http.Handle("/nginxes", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
+	http.Handle("/nginxes/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
 		payload, err := json.Marshal(commandService.GetNginxes())
 		if err != nil {
 			log.Warnf("%v", err)
@@ -78,7 +78,7 @@ func main() {
 		rw.Write(payload)
 	}))
 
-	http.Handle("/configs/chunked", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
+	http.Handle("/configs/chunked/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
 		payload, err := json.Marshal(commandService.GetChunks())
 		if err != nil {
 			log.Warnf("%v", err)
@@ -87,7 +87,7 @@ func main() {
 		rw.Write(payload)
 	}))
 
-	http.Handle("/configs/raw", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
+	http.Handle("/configs/raw/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
 		confFiles, auxFiles := commandService.GetContents()
 		response := map[string]interface{}{}
 		for _, confFile := range confFiles {
@@ -106,7 +106,7 @@ func main() {
 		rw.Write(payload)
 	}))
 
-	http.Handle("/configs", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
+	http.Handle("/configs/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
 		payload, err := json.Marshal(commandService.GetConfigs())
 		if err != nil {
 			log.Warnf("%v", err)
@@ -115,7 +115,7 @@ func main() {
 		rw.Write(payload)
 	}))
 
-	http.Handle("/metrics", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
+	http.Handle("/metrics/", http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
 		payload, err := json.Marshal(metricsService.GetMetrics())
 		if err != nil {
 			log.Warnf("%v", err)