About this repository 
This is the documentation site for Travis CI! (https://docs.travis-ci.com/)
How to contribute
Fork the repository, read the rest of this README file and make some changes.
Once you're done with your changes send a pull request. Thanks!
How to check your edit before sending PR
You can inspect how your edits will be reflected by the documentation site. Either by clicking on the Netlify preview link in your Pull Request or building the docs locally.
Install dependencies
-
Make sure you have Ruby and RubyGems installed.
-
Install bundler:
$ gem install bundler -
Install application dependencies:
$ bundle install --binstubs
Generate documentation
Run
$ ./bin/jekyll build
Run application server
You are now ready to start your documentation site, using Jekyll or Puma.
For documentation edits, Jekyll is sufficient.
Starting and inspecting edits with Jekyll
-
Run Jekyll server:
$ ./bin/jekyll serve -
Open localhost:4000 in your browser.
Starting and inspecting edits with Puma
For more programmatical PRs (such as handling webhooks notification
via POST), Puma is necessary.
-
Run Puma server:
$ ./bin/puma -
Open localhost:9292 in your browser.
API V2 documentation
API V2 (and 2.1) documentation is maintained in slate/source and is generated at build time from source.
License
Distributed under the MIT license; the same as other Travis CI projects.