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

Correct link for environment variables setup #789

Merged
merged 2 commits into from Oct 22, 2018
Merged

Correct link for environment variables setup #789

merged 2 commits into from Oct 22, 2018

Conversation

ghost
Copy link

@ghost ghost commented Oct 7, 2018

Fixes #788

Checklist

  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the [Contribution Guide] and my PR follows them.
  • I updated my branch with the master branch.
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation about the functionality in the appropriate .md file
  • I have added in line documentation to the code I modified

Short description of what this PR does:

  • Update the link for environment variables to the correct one

If you have questions, please send an email to Sendgrid, or file a Github Issue in this repository.

@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 7, 2018
@SendGridDX
Copy link
Collaborator

SendGridDX commented Oct 7, 2018

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@reedsa reedsa left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution! Just a quick recommendation and then I'll be happy to approve.

@@ -74,7 +74,7 @@ We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](h
<a name="environment"></a>
## Environment Variables and Your SendGrid API Key

All of our examples assume you are using [environment variables](https://github.com/sendgrid/sendgrid-nodejs#setup-environment-variables) to hold your SendGrid API key.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should use a relative link here instead so that GH always transforms the link properly regardless of the branch someone may be on.

Copy link
Author

Choose a reason for hiding this comment

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

Thank you for the feedback. Made the change to use a relative link.

Copy link
Contributor

@reedsa reedsa left a comment

Choose a reason for hiding this comment

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

Perfect, thanks for the update!

@reedsa reedsa added status: ready for deploy code ready to be released in next deploy and removed status: code review request requesting a community code review or review from Twilio labels Oct 9, 2018
@devchas devchas added the status: work in progress Twilio or the community is in the process of implementing label Oct 17, 2018
@thinkingserious thinkingserious added hacktoberfest difficulty: easy fix is easy in difficulty type: docs update documentation change not affecting the code and removed status: work in progress Twilio or the community is in the process of implementing labels Oct 22, 2018
@thinkingserious thinkingserious merged commit 65bf16c into sendgrid:master Oct 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: easy fix is easy in difficulty status: ready for deploy code ready to be released in next deploy type: docs update documentation change not affecting the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TROUBLESHOOTING.md: Link for environment variables does not direct to correct place
4 participants