Skip to content

Conversation

@JTorreG
Copy link
Contributor

@JTorreG JTorreG commented Dec 6, 2022

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/

@netlify
Copy link

netlify bot commented Dec 6, 2022

Deploy Preview for agent-public-docs ready!

Name Link
🔨 Latest commit 1b0e020
🔍 Latest deploy log https://app.netlify.com/sites/agent-public-docs/deploys/639085b87bd36d00094db276
😎 Deploy Preview https://deploy-preview-135--agent-public-docs.netlify.app/nginx-agent/overview
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions github-actions bot added dependencies documentation Improvements or additions to documentation enhancement New feature or request labels Dec 6, 2022
@JTorreG JTorreG self-assigned this Dec 6, 2022
@JTorreG JTorreG changed the title feat: publish Hugo docs draft: feat: publish Hugo docs Dec 6, 2022
Copy link

@mtbChef mtbChef left a 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.

@oCHRISo oCHRISo requested a review from dhurley December 8, 2022 17:28
@JTorreG JTorreG changed the title draft: feat: publish Hugo docs feat: publish Hugo docs Dec 9, 2022
```bash
sudo apt install golang-go
```

Copy link
Contributor

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 ?

Copy link

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.

Copy link
Contributor Author

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.

@oliveromahony oliveromahony merged commit 638a4a1 into main Dec 9, 2022
@oliveromahony oliveromahony deleted the hugo-docs branch December 9, 2022 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants