The Travis CI Documentation
CSS HTML JavaScript Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Stale bot should ignore ready-to-doc Jul 11, 2018
_data Add Xcode 10 beta 6 Aug 16, 2018
_includes FIx the headinging anchors (#1960) Aug 1, 2018
_layouts FIx the headinging anchors (#1960) Aug 1, 2018
_plugins Refactor POST request response May 28, 2017
assets Rip out the old JS TOC generator and use liquid instead (#1909) Jul 25, 2018
images Stages gif without beta Jul 16, 2018
legal Rip out the old JS TOC generator and use liquid instead (#1909) Jul 25, 2018
newsletter We dont use this, send people to the blog instead Dec 14, 2017
slate Minimal clarification of .com/org (#1961) Aug 17, 2018
user Minimal clarification of .com/org (#1961) Aug 17, 2018
.alexrc Config for inclusive language Nov 9, 2016
.coafile Config for inclusive language Nov 9, 2016
.gitignore Ignore the node data file Mar 15, 2018
.rubocop.yml Rubocop auto-fixes, but only in the Rakefile Nov 30, 2017
.rubocop_todo.yml Rubocop auto-fixes, but only in the Rakefile Nov 30, 2017
.ruby-version Fixing Slate Dependencies and issues (#1751) Mar 15, 2018
.travis.yml Fixing Slate Dependencies and issues (#1751) Mar 15, 2018
404.html Rip out the old JS TOC generator and use liquid instead (#1909) Jul 25, 2018
CNAME Set CNAME to docs.travis-ci.com Jan 16, 2014
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Apr 2, 2018
Gemfile Move Middleman config to root dir because Heroku (#1760) Mar 16, 2018
Gemfile.lock Updates! (#1919) Jul 3, 2018
Procfile Switch to Puma for serving pages Nov 20, 2015
README.md Generate API docs at serve time (#1745) Mar 12, 2018
Rakefile Fix node.js regex to support v10.0.0 Apr 25, 2018
STYLE.md Rip out the old JS TOC generator and use liquid instead (#1909) Jul 25, 2018
_config.yml Move Middleman config to root dir because Heroku (#1760) Mar 16, 2018
config.rb fix path to assets when visiting /api (#1813) May 1, 2018
config.ru Use Faraday to make HTTP requests May 28, 2017
favicon.ico updated favicon Mar 3, 2015
feed.build-env-updates.xml Populate this! Mar 7, 2018
imprint.md Rip out the old JS TOC generator and use liquid instead (#1909) Jul 25, 2018
index.html Rip out the old JS TOC generator and use liquid instead (#1909) Jul 25, 2018

README.md

About this repository Build Status

This is the documentation site for Travis CI! (http://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.

Install dependencies

  1. Make sure you have Ruby and RubyGems installed.

  2. Install bundler:

    $ gem install bundler
  3. 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

  1. Run Jekyll server:

    $ ./bin/jekyll serve
  2. 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.

  1. Run Puma server:

    $ ./bin/puma
  2. Open localhost:9292 in your browser.

API V2 documentation

API V2 (and 2.1) documentation is maintained in slate/source and updated is now generated at build time from source.

License

Distributed under the MIT license; the same as other Travis CI projects.