Skip to content
This repository has been archived by the owner on May 24, 2023. It is now read-only.

Add supporting documents to ns1 agent #2

Merged
merged 1 commit into from
Sep 20, 2019
Merged

Add supporting documents to ns1 agent #2

merged 1 commit into from
Sep 20, 2019

Conversation

ampant
Copy link
Contributor

@ampant ampant commented Sep 18, 2019

No description provided.

@ampant ampant requested a review from Rulox September 18, 2019 08:04
@Rulox Rulox requested a review from Dean-Coakley September 18, 2019 10:56
Copy link
Contributor

@Rulox Rulox left a 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!

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`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* nginx-ns1-gslb configuration from `/etc/nginx/config.yaml`
* nginx-ns1-gslb `yaml` configuration file.

.github/ISSUE_TEMPLATE/bug_report.md Show resolved Hide resolved
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!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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`
Copy link
Contributor

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.

@Dean-Coakley Dean-Coakley added the documentation Pull requests/issues for documentation label Sep 18, 2019
Copy link

@Dean-Coakley Dean-Coakley left a 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

@ampant ampant changed the title Add oss file to ns1 agent Add supporting oss documents to ns1 agent Sep 19, 2019
@ampant ampant changed the title Add supporting oss documents to ns1 agent Add supporting documents to ns1 agent Sep 19, 2019
Copy link
Contributor

@Rulox Rulox left a 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!

@ampant
Copy link
Contributor Author

ampant commented Sep 20, 2019

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
@ampant ampant merged commit 86a3cda into master Sep 20, 2019
@ampant ampant deleted the oss-files branch September 20, 2019 06:37
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants