Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos on Getting_Started.md #135

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix typos on Getting_Started.md #135

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8e9c66
fix typo on Getting_Started.md file: JSS to JS
jorgedavila25 May 21, 2013
85fcfa3
more clarity on the Getting_started docs
jorgedavila25 May 21, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ specify order (A should come before B).

Your pipeline is written in an `Assetfile`. The `Assetfile` uses a nice
DSL to make things easier. The `Assetfile` should live in your project's
root directory.
root directory.

Let's get started by writing a basic pipeline. Assume we have this
directory structure:
Expand All @@ -26,12 +26,12 @@ directory structure:
/source
/css
/javascript
/compiled
/compiled
Assetfile
```

The pipeline should simply concatenate all the individual JSS and CSS
files into single files. So the JSS and CSS directories are the inputs
The pipeline should simply concatenate all the individual JS and CSS
files into single files. So the JS and CSS directories are the inputs
and 2 files are outputs. The `source` directory is input and the output
will go into `compiled`. Here's the `Assetfile` to do just that:

Expand Down Expand Up @@ -135,7 +135,7 @@ concatenate files. You must write your own filters to do this. Luckily,
writing filters is pretty easy. Filters are classes that have
`generate_output` method. This is core API requirement. There also other
method you may implement, but this is the most important. Let's take a
stab at writing a coffeescript filter.
stab at writing a coffeescript filter.

Filters are Ruby classes. They map a set of inputs to outputs and
finally generate the output. Here is an absolute bare bones filter:
Expand Down Expand Up @@ -190,7 +190,7 @@ you may have noticed they are compiled "in place". This means
This works in our simple example, but what happens when we need to work
with Javascript later in the pipeline or next build steps expect ".js"
files? The filter has to customize the name. The most correct thing to
do is make the output file has the same name except as ".js".
do is make the output file have the same name except with a ".js" extension.

This behavior is defined in the filter's initializer. This may seem odd
to you. It was odd to me until I understood what was happening.
Expand Down Expand Up @@ -228,7 +228,7 @@ input "source" do
filter CoffeeScript
end

# Select the JS generated by previous filters.
# Select the JS generated by previous filters.
match "javascript/**/*.js" do
concat "application.js"
end
Expand Down Expand Up @@ -258,7 +258,7 @@ end
That covers the basics of writing filters. There is much more you can do
with filters that are outside the scope of this guide. You can find many
useful (as well as plenty of examples) in the
[rake-pipeline-web-filters](https://github.com/wycats/rake-pipeline-web-filters)
[rake-pipeline-web-filters](https://github.com/wycats/rake-pipeline-web-filters)
project.

That also concludes this guide. You should know everything you need to
Expand Down