Skip to content
This repository was archived by the owner on Jun 28, 2023. It is now read-only.

Update the README #12

Merged
merged 5 commits into from
Dec 15, 2014
Merged

Update the README #12

merged 5 commits into from
Dec 15, 2014

Conversation

gabebw
Copy link
Contributor

@gabebw gabebw commented Dec 4, 2014

Update the docs

@gabebw gabebw force-pushed the gbw-make-it-better branch from e537dc3 to af2e18f Compare December 4, 2014 18:44
@@ -22,7 +22,11 @@ The Vagrantfile will allow you to rebuild the RailsBridge VM from scratch. Run:

rake up

This just runs `vagrant up`. The base box will be downloaded directly from Ubuntu if it hasn't already been added. Building Ruby takes a while, so get some coffee.
This just runs `vagrant up`. Don't worry about the red text - unless the process
Copy link
Contributor Author

Choose a reason for hiding this comment

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

At least, I assume I shouldn't worry about the red text!

Copy link
Member

Choose a reason for hiding this comment

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

What's the red text?!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Try cloning this repo then running vagrant up. There's red text periodically.

Copy link
Member

Choose a reason for hiding this comment

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

Anything that the install process prints to stderr (as opposed to stdout) gets colored red. (Good thing regular terminals don't do this, heh...)

The note here is good but I'm trying to avoid hard line breaks in this file; can you re-wrap? (the graf in 25-27 should be on one line)

@gabebw gabebw force-pushed the gbw-make-it-better branch from af2e18f to 955cbbe Compare December 4, 2014 18:45
@gabebw
Copy link
Contributor Author

gabebw commented Dec 4, 2014

This is a continuation of https://github.com/railsbridge-boston/docs/issues/25.

@gabebw
Copy link
Contributor Author

gabebw commented Dec 4, 2014

@decklin Assuming this is merged, can you take care of creating the gold master and uploading to S3?

@gabebw gabebw force-pushed the gbw-make-it-better branch from 955cbbe to 88adebc Compare December 4, 2014 21:01
@mxie
Copy link
Member

mxie commented Dec 4, 2014

This looks fine to me.

Any thoughts, @decklin?

@@ -48,6 +52,11 @@ Files are copied into the VM from these directories:
* `etcfiles` to `/etc` (as root)
* `dotfiles` to `/home/vagrant` (as the user)

To apply your changes to the local Vagrant box that you booted with `vagrant
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there a better way?

Copy link
Member

Choose a reason for hiding this comment

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

Well, vagrant up should re-run the provison, which should be idempotent, but will definitely re-run more than it strictly needs to. I'll have to think about this.

@decklin
Copy link
Member

decklin commented Dec 6, 2014

Thanks - I will take a look at this tomorrow!

[push]
# This makes it push master when someone types `git push heroku`
# instead of `git push heroku master`
default = current
Copy link
Member

Choose a reason for hiding this comment

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

No, this should be "simple" (see http://git-scm.com/docs/git-config), that's the new default.

Trusty is still on git 1.9.1; the comment should say that it's to match the default behavior of git 2.0 (which is what students will get if they later install it directly/with homebrew/from backports).

@decklin
Copy link
Member

decklin commented Dec 8, 2014

Made some line comments - could you split this up into the doc updates and the git stuff? (2 PRs)

@decklin decklin mentioned this pull request Dec 8, 2014
@gabebw gabebw force-pushed the gbw-make-it-better branch from 88adebc to 92db895 Compare December 9, 2014 01:43
@gabebw
Copy link
Contributor Author

gabebw commented Dec 9, 2014

I force-pushed this so it's just the README updates. I'll leave the dotfiles and git changes to #16.

@@ -48,6 +50,10 @@ Files are copied into the VM from these directories:
* `etcfiles` to `/etc` (as root)
* `dotfiles` to `/home/vagrant` (as the user)

To apply your changes to the local Vagrant box that you booted with `vagrant up`, run `vagrant destroy` and then `vagrant up` again.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@decklin's previous comment:

Well, vagrant up should re-run the provison, which should be idempotent, but will definitely re-run more than it strictly needs to. I'll have to think about this.

@gabebw gabebw changed the title Remove a bunch of scary warnings around Git Update the docs Dec 9, 2014
@gabebw gabebw changed the title Update the docs Update the README Dec 10, 2014
@decklin
Copy link
Member

decklin commented Dec 15, 2014

Added one commit, merge if it looks good to you.

@gabebw
Copy link
Contributor Author

gabebw commented Dec 15, 2014

I like that we recommend vagrant up instead of hiding it behind Rake. Merging.

@gabebw gabebw force-pushed the gbw-make-it-better branch from ac4545b to 1f3d373 Compare December 15, 2014 21:47
@gabebw gabebw merged commit 1f3d373 into master Dec 15, 2014
@gabebw gabebw deleted the gbw-make-it-better branch December 15, 2014 21:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants