Merge branch 'main' into add-api-docs

.github/workflows/ci.yml

@@ -21,12 +21,14 @@ jobs:
         with:
           version: "${{ env.GOLANGCI_LINT_VERSION }}"
           args: -c ./scripts/.golangci.yml
+          skip-pkg-cache: true
       - name: Lint SDK Code
         uses: golangci/golangci-lint-action@v3
         with:
           version: "${{ env.GOLANGCI_LINT_VERSION }}"
           working-directory: sdk
           args: -c ../scripts/.golangci.yml
+          skip-pkg-cache: true
 
   unit-test:
     name: Unit Tests

go.mod

@@ -42,6 +42,7 @@ require (
 	github.com/nginx/agent/sdk/v2 v2.0.0-00010101000000-000000000000
 	github.com/prometheus/client_golang v1.13.0
 	github.com/rs/cors v1.8.2
+	gopkg.in/yaml.v2 v2.4.0
 )
 
 require (
@@ -81,7 +82,6 @@ require (
 	google.golang.org/genproto v0.0.0-20220805133916-01dd62135a58 // indirect
 	gopkg.in/ini.v1 v1.66.6 // indirect
 	gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
 )
 
 replace github.com/nginx/agent/sdk/v2 => ./sdk

docs/README.md → hugo/README.md

@@ -5,10 +5,8 @@ This folder houses the product documentation for the NGINX Agent:
 Directory Tree:
 
 ```shell
-└──docs
-    └── content
-        ├── 
-        └── 
+└──hugo
+    └──content
 ```
 
 ## Where to Find Docs Online

docs/content/overview.md → hugo/content/overview.md

@@ -17,13 +17,13 @@ NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus insta
 - Notifications of NGINX events
 
 
-{{< img src="docs/grafana-dashboard-example.png" caption="Grafana  dashboard showing metrics reported by NGINX Agent" alt="Grafana dashboard showing metrics reported by NGINX Agent" width="99%">}}
+{{< img src="grafana-dashboard-example.png" caption="Grafana  dashboard showing metrics reported by NGINX Agent" alt="Grafana dashboard showing metrics reported by NGINX Agent" width="99%">}}
 
 ## How it Works
 
 NGINX Agent runs as a companion process on a system running NGINX. It provides gRPC and REST interfaces for configuration management and metrics collection from the NGINX process and operating system. NGINX Agent enables remote interaction with NGINX using common Linux tools and unlocks the ability to build sophisticated monitoring and control systems that can manage large collections of NGINX instances.
 
-{{< img src="docs/agent-flow.png" caption="How Agent works" alt="How NGINX Agent works" width="99%">}}
+{{< img src="agent-flow.png" caption="How Agent works" alt="How NGINX Agent works" width="99%">}}
 
 
 ## Configuration Management

docs/go.mod → hugo/go.mod

@@ -1,4 +1,4 @@
-module github.com/nginx/agent/docs
+module github.com/nginx/agent/hugo
 
 go 1.18