Skip to content

Latest commit

 

History

History
104 lines (65 loc) · 3.87 KB

README.md

File metadata and controls

104 lines (65 loc) · 3.87 KB
Raw

About Travis CI Repository Build Status

This is the documentation site for Travis CI!. Follow this guide to learn how to add new documentation and how to update existing documentation.

Add Documentation

The following are the steps to add documentation.

  1. Review the Travis CI documentation guidelines.
  2. Check existing documentation. Verify that the documentation does not already exist or look for related documentation that can be enhanced.
  3. Determine proper placement. In the Travis CI repository, browse to the user folder (or any other specific folder) and create a new branch.
  4. Create a new file and add the new documentation files.
  5. Ensure to insert the name and extension for the file.
  6. Commit your changes and add a short message to describe your changes.
  7. Test the changes locally to verify your edits.
  8. Submit a pull request. Include a clear title and description of the proposed changes, and click “Create pull request.”

Thank you for your contribution! The Travis CI team will review the pull request and approve any necessary changes.

Update Existing Documentation

If you see a page that needs to be updated or that can be improved, follow these steps to update Travis CI's existing documentation.

  1. Review the Travis CI documentation guidelines.
  2. Identify the Travis CI docs page that needs to be updated.
  3. Click the “Improve this page on GitHub” button in the top right corner.
  4. Once on GitHub, edit the relevant file.
  5. Commit your changes. Name your branch, and click the “Propose changes” button.
  6. Build the docs in a local environment to verify your edits.
  7. Submit a pull request. Ensure a clear title and description of the proposed changes are added, and click “Create pull request.”

Thank you for your contribution. The Travis CI team will review the pull request and approve any necessary changes.

Build Local Environment

You can inspect how the documentation site will reflect your edits. Follow the steps below to learn how to build your local environment and check all your edits before sending the pull request for approval.

Install Dependencies

Follow the steps below to install dependencies.

  1. Ensure you have Ruby and RubyGems installed.

  2. Clone the Travis CI docs repository.

  3. Install bundler as follows:

    $ gem install bundler

  4. Next, install application dependencies:

    $ bundle install --binstubs

Generate Documentation

To generate the documentation, run the following command:

$ ./bin/jekyll build

Run the Application Server

You are ready to start your local documentation site using Jekyll or Puma. For documentation edits, Jekyll is sufficient.

Edit with Jekyll

To start and inspect your edits using Jekyll, follow the steps below:

  1. Run the Jekyll server:

    $ ./bin/jekyll serve

  2. Open localhost:4000 in your browser.

Edit with Puma

For more programmatical pull requests (such as handling webhooks notifications via POST), Puma is necessary. To start and inspect your edits using Puma, follow the steps below:

  1. Run the Puma server:

    $ ./bin/puma

  2. Open localhost:9292 in your browser.

API Documentation

All Travis CI API V2 (and 2.1) documentation is maintained in slate/source and generated from the source at build time.

License

Distributed under the MIT license, like other Travis CI projects.