-
Notifications
You must be signed in to change notification settings - Fork 4
Add supporting documents to ns1 agent #2
Conversation
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.
Hey @ampant thanks.
Just a few suggestions regarding differences between this and other projects. Thanks!
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
Provide the following files as part of the bug report | ||
|
||
* NGINX Plus configuration. Run `sudo nginx -T` to gather the full configuration | ||
* nginx-ns1-gslb configuration from `/etc/nginx/config.yaml` |
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.
* nginx-ns1-gslb configuration from `/etc/nginx/config.yaml` | |
* nginx-ns1-gslb `yaml` configuration file. |
CONTRIBUTING.md
Outdated
@@ -0,0 +1,70 @@ | |||
# Contributing Guidelines | |||
|
|||
The following is a set of guidelines for contributing to the NGINX AWS Auto-Scale Group Sync tool. We really appreciate that you are considering contributing! |
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.
The following is a set of guidelines for contributing to the NGINX AWS Auto-Scale Group Sync tool. We really appreciate that you are considering contributing! | |
The following is a set of guidelines for contributing to the NGINX Plus NS1 GLSB tool. We really appreciate that you are considering contributing! |
CONTRIBUTING.md
Outdated
|
||
* nginx-ns1-gslb is a service written in Go that works with NGINX Plus. | ||
* The main code is found under `/cmd/agent/` | ||
* Tools for building the service for supported Operating Systems are found under `/build/package` |
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 line needs to be removed as we don't provide any packaging solution yet.
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.
👍 on all @Rulox change requests
Please update the PR title to something more descriptive.
Perhaps something like:
Add supporting documentation expected of an OSS project
Adds contributing guide, issues template,...etc
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.
Looks good!
Please remember to squash commits before merging. I also think a more meaningful comment for the commit like Add supporting documents
will be good, but up to you.
Thanks!
Thanks |
Addressed changes
No description provided.