Refactor readme links and minor edits to text #81
Conversation
README.md
Outdated
|
|
||
| 6. Make a new PR, merging [staging][] into the [beta][] branch. | ||
| 7. Get this PR merged, and wait for Travis to make a deployment to [beta][]. | ||
| 8. CELEBRATE! :tada: |
There was a problem hiding this comment.
I think step 8 should be 'verify it works correctly on beta', similar to point 5.
There was a problem hiding this comment.
Good suggestion. Will update that.
There was a problem hiding this comment.
lgtm!
Since you've explicitly requested reviews from @minrk and @choldgraf, I'm going to hold off on merging this :)
| @@ -1,100 +1,120 @@ | |||
| # [mybinder.org-deploy][] | |||
|
|
|||
| This repository contains configuration files and documentation related to the | |||
| [binderhub](https://github.com/jupyterhub/binderhub) deployment open to the | |||
| public at [beta.mybinder.org](https://beta.mybinder.org). | |||
| [binderhub][] deployment open to the public at [beta.mybinder.org][]. | |||
There was a problem hiding this comment.
how is it that I have written so much .md and have never discovered this feature of it?
| to [staging.mybinder.org][]. | ||
| 4. Go to [staging.mybinder.org][] to look at the changes. | ||
| 5. Verify that [staging.mybinder.org][] works as intended. Please take your | ||
| time to check that the change is working as expected. |
There was a problem hiding this comment.
What do folks think about (in a diff PR) having a "test" repo that we tell people to build to make sure it works? I feel like being explicit about "you should really make sure staging works" is important
There was a problem hiding this comment.
I think that ties into #10. I'm not sure if we can provide explicit instructions when we can automate it instead...
my strategy is to make a dummy commit to http://github.com/yuvipanda/example-requirements and then make sure it builds..
There was a problem hiding this comment.
ya I agree automating would be better
There was a problem hiding this comment.
Good point. Let's leave as is here and flesh out when addressing #10.
README.md
Outdated
| ## Upgrading dependencies for the mybinder.org deployment | ||
|
|
||
| Upgrading dependencies used by [mybinder.org][] requires making changes | ||
| to the `config` files of repositories that are used to build the |
There was a problem hiding this comment.
I think this would be "config file of the repository that is used to build the mybinder.org service" (singular) since it's always common.yaml and it's always in this repo. Does that sound right?
There was a problem hiding this comment.
Good catch. Will reword.
|
this is great! some small comments but other than that LGTM |
|
@willingc can you resolve conflicts? I think we can merge after. |
|
Conflicts resolved |
This PR is a follow up to #48. The target audience is someone who does deploys infrequently to mybinder.org.