-
Notifications
You must be signed in to change notification settings - Fork 100
feat: publish Hugo docs #135
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
Conversation
✅ Deploy Preview for agent-public-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
mtbChef
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's quite a bit here that's out of scope for my review. Now that the latest README PR has been merged, we ultimately want this content to mirror that version.
https://github.com/nginx/agent/blob/main/README.md
I did notice that some of the content is a bit stale. For example, the file docs/static/docs/nim-agent-00.png part of this PR is older. We are no longer using the NIM graphic. Please refer to the latest README for the updated Grafana graphic.
| ```bash | ||
| sudo apt install golang-go | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@oliveromahony Isn't this setup very limiting without
make install-tools? And maybe sudo apt install protobuf-compiler ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is what's in our readme. We also suggest downloading Go from the official website. Should we add the above packages there as well? It didn't throw an immediate flag for me because building and running from source worked in my vm.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this PR has been merged now, for changes, we can open a new PR with the change suggestions. Merging the PR to main will update the production docs.nginx.com website.
Proposed changes
Creates Hugo-based documentation for docs.nginx.com/nginx-agent based on the github readme.
Preview: https://deploy-preview-135--agent-public-docs.netlify.app/nginx-agent/