summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorDivay Prakash <divayprakash3@gmail.com>2018-11-18 00:32:47 +0530
committerDivay Prakash <divayprakash3@gmail.com>2018-11-18 00:32:47 +0530
commit195e46d15f9e91cc8f7e8b8ad457ac02c86c6b98 (patch)
treece967f0713850542e8e1dddedd3f11a33ab5222b
parentbcd10cdd362a3996af82998f1073c44645dc4d2d (diff)
Update local site building instructions
-rw-r--r--CONTRIBUTING.markdown11
1 files changed, 8 insertions, 3 deletions
diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown
index 0c35c3f2..e2b849bd 100644
--- a/CONTRIBUTING.markdown
+++ b/CONTRIBUTING.markdown
@@ -89,9 +89,14 @@ You can buid the site locally to test your changes. Follow the steps below.
* Install Middleman and other required dependencies using Bundler.
* `cd learnxinyminutes-site/`
* `bundle install`
-* Checkout the [learnxinyminutes-docs](https://github.com/adambard/learnxinyminutes-docs) repo as `source/docs`.
- * `cd source/docs/`
- * `git clone https://github.com/adambard/learnxinyminutes-docs ./source/docs/`
+* Get the source in place
+ * Copy the contents of your clone of the fork of learnxinyminutes-docs repo
+ into the `source/docs` folder. There shouldn't be a learnxinyminutes-docs
+ folder inside the `docs` folder, it should just contain all the repo
+ contents.
+ * Checkout your fork of the learnxinyminutes-docs repo as `source/docs`.
+ * `cd source/docs/`
+ * `git clone https://github.com/YOUR-USERNAME/learnxinyminutes-docs ./source/docs/`
* Build the site or run a development server to test your changes (NOTE: run
these commands at `learnxinyminutes-site/`).
* Build - `bundle exec middleman build`