brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From drigod...@apache.org
Subject [1/3] brooklyn-docs git commit: minor tweaks to docs setup as i just did it on a new machine
Date Tue, 20 Jun 2017 09:40:56 GMT
Repository: brooklyn-docs
Updated Branches:
  refs/heads/master b86635c2e -> 23c890191


minor tweaks to docs setup as i just did it on a new machine


Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/28f91f5f
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/28f91f5f
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/28f91f5f

Branch: refs/heads/master
Commit: 28f91f5f1d71be3af8fc8856595f6eef5dee834b
Parents: b86635c
Author: Alex Heneveld <alex.heneveld@cloudsoftcorp.com>
Authored: Thu Apr 13 17:35:29 2017 +0100
Committer: Alex Heneveld <alex.heneveld@cloudsoftcorp.com>
Committed: Tue Jun 20 10:36:14 2017 +0100

----------------------------------------------------------------------
 README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/28f91f5f/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 21ab6a3..5e560a0 100644
--- a/README.md
+++ b/README.md
@@ -29,16 +29,16 @@ The Brooklyn documentation uses [Jekyll](https://jekyllrb.com/) to process
the s
 This in turn requires Ruby and gems as described in the `Gemfile`:
 install [RVM](http://rvm.io/) to manage Ruby installations and sets of Ruby gems.
 
-    \curl -sSL https://get.rvm.io | bash -s stable
+    \curl -sSL https://get.rvm.io | bash -s stable --auto-dotfiles
 
 Close your shell session and start a new one, to get the new
 environment that RVM has configured. Change directory to the location where
-you checked out your repository and then to the `docs/` subdirectory (where this file is
located).
+this project is (where this file is located).
 
 RVM should detect its configuration inside `Gemfile` and try to configure itself. 
 Most likely it will report that the required version of Ruby is not installed,
 and it will show the command that you need to run to install the correct version. 
-Follow the instructions it shows.
+Follow the instructions it shows, typically something like `rvm install ruby-2.1.2`.
 
 Once the correct version of Ruby is installed, change to your home directory
 and then change back (`cd ~ ; cd -`).
@@ -50,7 +50,7 @@ at the correct versions:
     bundle install
 
 Any time you need to reset your Ruby environment for `jekyll` to run correctly,
-return to the `_build` directory and re-run the above command.
+go to this directory (or the `_build` subdir) and re-run the above command.
 
 On some platforms there may be some fiddling required before `jekyll` runs without errors,
 but the ecosystem is fairly mature and most problems can be resolved with a bit of googling.
@@ -69,7 +69,7 @@ You can download it from [here](http://wkhtmltopdf.org/downloads.html) or
use th
 Seeing the Website and Docs
 ---------------------------
 
-To build and most of see the documentation, run this command in your `docs` folder:
+To build and most of see the documentation, run this command in this folder:
 
     jekyll serve
     


Mime
View raw message