Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: move hugo-docs to hugo folder #156

Merged
merged 3 commits into from
Jan 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
File renamed without changes.
6 changes: 2 additions & 4 deletions docs/README.md → hugo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/content/overview.md → hugo/content/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/go.mod → hugo/go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/nginx/agent/docs
module github.com/nginx/agent/hugo

go 1.18

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/netlify.toml → hugo/netlify.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[build]
command = "hugo --gc -b $DEPLOY_PRIME_URL/nginx-app-protect-dos"
command = "hugo --gc -b $DEPLOY_PRIME_URL/nginx-agent"
publish = "public"

[build.environment]
Expand Down
Loading