Skip to content

Commit

Permalink
Merge pull request #125 from mannylopez/doc-update
Browse files Browse the repository at this point in the history
fix links, language, and syntax for Get Started files
  • Loading branch information
ungoldman committed Mar 30, 2015
2 parents 15c12b9 + c30ffa7 commit 814e03a
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions docs/source/get-started/_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ To run a development environment, just type `grunt`. You should have a copy of t

### How We Use GitHub

All the code for Calcite Web lives [on GitHub](https://github.com/esri/calcite-web). We use the [fork and pull model](https://help.github.com/articles/using-pull-requests/) to manage contribution. To contribute, you should:
All the code for Calcite Web lives on [GitHub](https://github.com/esri/calcite-web). We use the [fork and pull model](https://help.github.com/articles/using-pull-requests/) to manage contribution. To contribute, you should:

1. Commit your changes.
2. Note your changes in `CHANGELOG.md`
3. Make sure your copy is up to date: `git pull upstream master`
4. Push your changes to your fork: `/your-username/calcite-web`
5. Open a pull-request from your fork (`/your-username/calcite-web`) to the 'upstream' fork (`/Esri/calcite-web`).
5. Open a pull-request from your fork (`/your-username/calcite-web`) to the 'upstream' fork (`/Esri/calcite-web`).
6 changes: 3 additions & 3 deletions docs/source/get-started/_install.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Calcite Web
# Install

Installing Calcite Web was designed to be fairly painless. If you have any problems, be sure to [submit an issue](https://github.com/Esri/calcite-web/issues/).

Expand All @@ -8,11 +8,11 @@ Calcite Web has three main dependencies. If you already have these on your compu

1. Visit [nodejs.org](http://nodejs.org/) to install Node.
2. `npm install -g grunt-cli` to install Grunt.
3. `gem install sass` to install SASS.
3. `gem install sass` to install Sass.

### Fork the Repository

All the code for Calcite Web lives [on GitHub](https://github.com/esri/calcite-web). We use the [fork and pull model](https://help.github.com/articles/using-pull-requests/) to manage contribution.
All the code for Calcite Web lives on [GitHub](https://github.com/esri/calcite-web). We use the [fork and pull model](https://help.github.com/articles/using-pull-requests/) to manage contribution.

1. Fork the repository so you have your own copy (`your-username/calcite-web`)
2. Clone the repo locally with `git clone https://github.com/your-username/calcite-web.git`
Expand Down
4 changes: 2 additions & 2 deletions docs/source/get-started/_npm.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ npm install --save-dev git://github.com/Esri/calcite-web.git
You can also use a specific release by appending the version number to the end:

```bash
npm install --save-dev git://github.com/Esri/calcite-web.git#v0.0.6
npm install --save-dev git://github.com/Esri/calcite-web.git#v0.0.10
```

Then, if you're using sass, be sure to add `node_modules/calcite-web/dist/sass/` to your load path along with the `list-files.rb` script (used for automatically generating sass from a folder of icons. If you're using `grunt-contrib-sass` you add that like this:
Expand All @@ -28,4 +28,4 @@ Then, if you're using sass, be sure to add `node_modules/calcite-web/dist/sass/`
}
```

Then in your main `.scss` file, you can just require the framework: `@import "calcite-web";`. Everything mentioned about mixins above in the Ruby gem section applies to the Node module as well, so scroll up a bit and learn more about how Calcite Web functions as a Sass library;
Then in your main `.scss` file, you can just require the framework: `@import "calcite-web";`. Everything mentioned about mixins above in the [Ruby gem section](/#ruby-gem) applies to the Node module as well, so scroll up a bit and learn more about how Calcite Web functions as a Sass library;
12 changes: 6 additions & 6 deletions docs/source/get-started/_ruby-gem.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
## Ruby Gem

To install Calcite Web as a ruby gem, add a reference to the gem to your Gemfile:
To install Calcite Web as a ruby gem, add a reference of the gem to your Gemfile:

```ruby
gem "calcite-web", :git => "https://github.com/Esri/calcite-web.git", :tag => "v0.0.6"
gem "calcite-web", :git => "https://github.com/Esri/calcite-web.git", :tag => "v0.0.10"
```

Be sure to use the most up to date tag.
Be sure to use the most [up-to-date tag](https://github.com/Esri/calcite-web/releases).

Then in your project's sass file, just import it:
Then in your project's Sass file, just import it:

```scss
@import "calcite-web";
```

That will give you everything including sass utilities. You will also need to copy over the JavaScript and image assets to your static folder (see above).
That will give you everything including Sass utilities. You will also need to copy over the JavaScript and image assets to your static folder [(see above)](/#static-files).

Calcite Web has a built in library of mixins that cover everything from animation to font-size. To be sure you're building your site in the easiest way (and the most visually consistent way) read up on everything that's available on the [SASS Page](./sass).
Calcite Web has a built in library of mixins that cover everything from animation to font-size. To be sure you're building your site in the easiest way (and the most visually consistent way) read up on everything that's available on the [Sass Page](./sass).
2 changes: 1 addition & 1 deletion docs/source/get-started/_static-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ When used statically, one very helpful thing to know is that Calcite Web comes b
</div>
```

This will keep spacing consistent and you won't have to write any CSS! There are modifier classes for virtually everything: padding, margin, text-color, background-color, etc. Be sure to read [the documentation to learn](http://esri.github.io/calcite-web/grid/) what is possible.
This will keep spacing consistent and you won't have to write any CSS! There are modifier classes for virtually everything: padding, margin, text-color, background-color, etc. Be sure to read [the documentation](http://esri.github.io/calcite-web/grid/) to learn what is possible.

0 comments on commit 814e03a

Please sign in to comment.