Rename H_SERVICE_URL to SIDEBAR_APP_URL #454
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `H_SERVICE_URL` environment variable is only used for one thing: to set the value of the `defaultSidebarAppUrl` variable (to https://hypothes.is/app.html in production or localhost:5000/app.html in dev) by appending `/app.html` to the end of the environment variable's value. For consistency with the config setting and variables that it's used to control, rename `H_SERVICE_URL` to `SIDEBAR_APP_URL` and require the user to include the `/app.html` ending in the environment variable's value. Also rewrite the documentation for this environment variable to make it clearer what it's used for. **Note**: This change means that developers who're using the `H_SERVICE_URL` environment variable in their development environments will need to: 1. Rename `H_SERVICE_URL` it to `SIDEBAR_APP_URL` in their environment 2. Append `/app.html` to the end of the environment variable's value For example: export SIDEBAR_APP_URL="http://localhost:5000/app.html" The developer docs for this environment variable have been updated to reflect this.
Codecov Report
@@ Coverage Diff @@
## master #454 +/- ##
==========================================
+ Coverage 89.86% 89.88% +0.01%
==========================================
Files 127 127
Lines 5031 5031
Branches 864 864
==========================================
+ Hits 4521 4522 +1
+ Misses 510 509 -1
Continue to review full report at Codecov.
|
robertknight
approved these changes
Jun 19, 2017
There was a problem hiding this comment.
LGTM. @seanh would you mind notifying internal & external devs on Slack / the dev mailing list?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
H_SERVICE_URLenvironment variable is only used for one thing: toset the value of the
defaultSidebarAppUrlvariable (tohttps://hypothes.is/app.html in production or localhost:5000/app.html in dev)
by appending
/app.htmlto the end of the environment variable's value.For consistency with the config setting and variables that it's used to
control, rename
H_SERVICE_URLtoSIDEBAR_APP_URLand require theuser to include the
/app.htmlending in the environment variable'svalue.
Also rewrite the documentation for this environment variable to make it
clearer what it's used for.
Note: This change means that developers who're using the
H_SERVICE_URLenvironment variable in their development environmentswill need to:
H_SERVICE_URLit toSIDEBAR_APP_URLin their environment/app.htmlto the end of the environment variable's valueFor example:
The developer docs for this environment variable have been updated to reflect
this.