Documentation for codeship.com
CSS HTML Ruby Shell CoffeeScript JavaScript
Latest commit 15ad263 Jan 18, 2017 @joesiewert joesiewert committed on GitHub Merge pull request #602 from codeship/python
Add notes for installing other Python versions
Permalink
Failed to load latest commit information.
.github Fix typos Oct 3, 2016
_basic Merge pull request #602 from codeship/python Jan 18, 2017
_data Specific wording about Docker versions Dec 22, 2016
_general Merge pull request #599 from codeship/security_update Jan 10, 2017
_includes Highlight the active collection Jan 7, 2017
_layouts Add Hubspot analytics tracking Dec 20, 2016
_plugins Replace custom sitemap plugin Apr 18, 2016
_pro removing header tag, making it bold Jan 13, 2017
_sass Fix broken mobile design Dec 21, 2016
assets Include OpenGraph and Twitter metadata Dec 16, 2016
basic Add missing page titles Jan 3, 2017
bin Prepare for Basic/Pro renaming Dec 21, 2016
external update postgres env variables Aug 22, 2016
general Add missing page titles Jan 3, 2017
images reducing image size Jan 12, 2017
metadata Move jsonp files to metadata subfolder May 8, 2015
pro Add missing page titles Jan 3, 2017
tags Fix sorting of the tags Sep 6, 2014
templates Fix typos Oct 3, 2016
.dockerignore Remove RVM specific configuration files May 9, 2016
.editorconfig Update .editorconfig to match linters Apr 13, 2016
.gitignore Add .jekyll-metadata to .gitignore May 11, 2016
.scss-lint.yml Enable & fix Shorthand Mar 11, 2015
404.md Missing redirects brought up by the SEO agency Nov 22, 2016
CODE_OF_CONDUCT.md update CoC to the latest version Feb 19, 2016
CONTRIBUTING.md Fix a wrong link in CONTRIBUTING Nov 9, 2015
Dockerfile Fixing table display and styling on Handling Secrets page Jan 12, 2017
Dockerfile.aws Don't copy _robots.txt Aug 22, 2016
Gemfile Add the `jekyll-redirect-from` plugin Nov 16, 2016
Gemfile.lock Add the `jekyll-redirect-from` plugin Nov 16, 2016
LICENSE.md Rename License and Readme and link to external documents Apr 14, 2015
README.md Add welcome post for classic infrastructure Oct 27, 2016
_config.yml Merge remote-tracking branch 'origin/master' into pro_guide Dec 22, 2016
_lifecycle.json Add a new Lifecycle cleanup rule May 19, 2016
_website.json Fix a syntax error Dec 22, 2016
codeship-services.yml Update configuration to new caching mechanism Jul 13, 2016
codeship-steps.yml Update steps to run configure the redirects on S3 Nov 21, 2016
codeship.asc Revert "remove key" Oct 5, 2015
deployment.env.encrypted Update Swiftype domain ID again Aug 22, 2016
dockercfg.encrypted Update configuration to new caching mechanism Jul 13, 2016
feed.xml Generate a RSS feed Apr 14, 2016
google1a85968316265362.html Add HTML file to verify for Google Webmaster Tools Aug 31, 2016
gulpfile.js Fixed gulp tasks Sep 1, 2016
index.html Fix some typos and add welcome post to index Nov 8, 2016
package.json Update Yarn installation Jan 6, 2017
robots.txt Add staging and private deploys to robots.txt Aug 30, 2016
yarn.lock Update to Jekyll v3.3.0 Oct 18, 2016

README.md

Codeship Documentation

Codeship Status for codeship/documentation Waffle.io Board Dependency Status License

Contributing

We are happy to hear your feedback. Please read our contributing guidelines and the code of conduct before you submit a pull request or open a ticket.

Getting Started

Prerequisites

We recommend using Docker to build and test the documentation. Running via Docker is only required if you plan to make changes to the styling or layout of the site.

For content related changes and fixes, it's easiest to use GitHub's File Edit UI to make the changes and create the pull request.

Setup

The first step is cloning and going into the repository.

git clone git@github.com:codeship/documentation.git
cd documentation

Then build the container and save it as a tagged image.

docker build --tag codeship/documentation .

You can now run commands via that container. By default, it will build the site and start the Jekyll development server.

docker run -it -p 4000:4000 -v $(pwd):/docs codeship/documentation

To access the site open http://IP_OF_YOUR_DOCKER_SERVER:4000 in your browser. Usually, this is localhost:4000.

On Windows, the Docker commands are executed via the Docker Quickstart Terminal. If localhost doesn't work, you might have to open a normal command prompt and type docker-machine ls. There you can take the IP that is listed under URL and type the IP (with port 4000) into your browser to reach the documentation.

Development

Updating dependencies

To update Rubygem based dependencies, update the Gemfile (if required) and run

docker run -it -v $(pwd):/docs codeship/documentation bundle update

For NPM based dependencies, run the following two commands

docker run -it -v $(pwd):/docs codeship/documentation yarn upgrade

Linting

SCSS

SCSS files are automatically linted using scss-lint. To run it, execute the following command

docker run -it -v $(pwd):/docs codeship/documentation bundle exec scss-lint

It's configured in .scss-lint.yml and the default configuration is available online as well.

JSON

docker run -it -v $(pwd):/docs codeship/documentation gulp lint

Jekyll

docker run -it -v $(pwd):/docs codeship/documentation bundle exec jekyll doctor

Markup

Table of contents

If you want to include a table of contents, include the following snippet in the markdown file

* include a table of contents
{:toc}

URL Helpers

Tags

Generate a URL for the specified tag (database in the example below). This function is also available as a filter and can be used with a variable (tag in the example).

{% tag_url databases %}
{{ tag | tag_url }}

generates the output as follows (depending on configuration values):

/tags/databases/

Man Pages

Link to a particular Ubuntu man page. The Ubuntu version currently defaults to Ubuntu Trusty.

{% man_url formatdb %}

generates the following output:

http://manpages.ubuntu.com/manpages/trusty/en/man1/formatdb.1.html