1
0
Fork 0
mirror of https://github.com/capistrano/capistrano synced 2023-03-27 23:21:18 -04:00
capistrano/docs
Dylan Frese f76fb81fe2
Add support for adding custom filters
Users of the API may now add their own 'on'-filters by calling
Configuration#add_filter, e.g:
`Capistrano::Configuration.env.add_filter(RegionFilter.new('NE'))`.

An filter object passed into this method must respond to .filter, and
this method should accept an array of Server objects and return a subset
of this array.

Tests have been added that checks that:
  * A filter can be added without throwing an error
  * Trying to add a filter without a filter method throws a
    TypeError
  * An added filter is used to filter a list of servers
  * add_filter accepts a block, and raises an ArgumentError
    if passed both a block and an object.
2016-12-09 18:11:15 -06:00
..
_includes Add support for adding custom filters 2016-12-09 18:11:15 -06:00
_layouts Move gh-pages site to the docs/ folder 2016-08-23 18:04:57 -07:00
_posts Move gh-pages site to the docs/ folder 2016-08-23 18:04:57 -07:00
css Move gh-pages site to the docs/ folder 2016-08-23 18:04:57 -07:00
documentation Add support for adding custom filters 2016-12-09 18:11:15 -06:00
fonts Move gh-pages site to the docs/ folder 2016-08-23 18:04:57 -07:00
images Move gh-pages site to the docs/ folder 2016-08-23 18:04:57 -07:00
js Move gh-pages site to the docs/ folder 2016-08-23 18:04:57 -07:00
_config.yml Move gh-pages site to the docs/ folder 2016-08-23 18:04:57 -07:00
CNAME Move gh-pages site to the docs/ folder 2016-08-23 18:04:57 -07:00
favicon.ico Move gh-pages site to the docs/ folder 2016-08-23 18:04:57 -07:00
Gemfile Fix RuboCop Style/StringLiterals violation 2016-08-26 17:33:15 -07:00
Gemfile.lock Move gh-pages site to the docs/ folder 2016-08-23 18:04:57 -07:00
index.markdown Remove remaining ref to old documentation repo 2016-08-30 18:02:20 -07:00
README.md Reference the new documentation location (docs/) 2016-08-26 17:33:15 -07:00

capistranorb.com

This docs/ directory generates the capistranorb.com site. Feel free to send pull requests to make improvements to Capistrano's documentation!

Quick start

This is a GitHub Pages project, which means it is built using Jekyll. To run the site locally, you'll need a functioning Ruby environment.

After checking out the capistrano repository, run:

cd docs
bundle install

Then start the Jekyll server with:

bundle exec jekyll serve

You should now be able to preview the site on http://localhost:4000. After making any changes to markdown or HTML files, just refresh your browser to see the results. You do not have to restart the Jekyll process.

More information: Using Jekyll with Pages.