Skip to content
Documentation for Codeship CI & CD service
HTML CSS Ruby Shell CoffeeScript Dockerfile JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fix typos Oct 3, 2016
_basic Update Chrome versions Sep 13, 2019
_data Update to ami-03990dafb08de3b70 Aug 13, 2019
_general Fix branches typo Aug 9, 2019
_includes
_layouts Last of the Codeship to CodeShip for product indicator Jul 8, 2019
_plugins Flip more links to https Nov 29, 2018
_pro Fixed documetation to match with example repo Sep 20, 2019
_sass fixed css syntax styling Jul 23, 2018
assets Update used logo (#1190) Feb 6, 2018
basic
bin Update Java versions Aug 13, 2019
collections Solutions emails Jan 3, 2019
external Heroku updates Nov 2, 2018
general Titles redo 4 May 23, 2017
getting-started Update links to be dynamic Jul 11, 2018
images This adds comments from the review. Jun 28, 2019
integrations Remove more HipChat Feb 15, 2019
metadata Move jsonp files to metadata subfolder May 8, 2015
more-resources Wrap heading block on special content pages into .col div Jun 30, 2017
pro Fix wording Dec 22, 2017
templates Removing community forum from docs Jul 11, 2018
tmp/site keep our volume folder around Mar 30, 2017
.dockerignore Add tmp directory to .dockerignore to speed up local builds Sep 12, 2017
.editorconfig Update .editorconfig to match linters Apr 13, 2016
.gitignore confirmed successful push Apr 29, 2019
.ruby-version
.scss-lint.yml Enable & fix Shorthand Mar 11, 2015
.spelling This updates the .spelling file with aes. Jul 20, 2019
404.md Update 404 page Jul 27, 2017
CODE_OF_CONDUCT.md Update maintainers listed in CoC Apr 4, 2017
CONTRIBUTING.md Fixed PR link (#933) Aug 2, 2017
Dockerfile Update to Ruby 2.6.4 Sep 5, 2019
Dockerfile.aws Don't copy _robots.txt Aug 22, 2016
Gemfile Update to Ruby 2.6.4 Sep 5, 2019
Gemfile.lock Update to Ruby 2.6.4 Sep 5, 2019
LICENSE.md Rename License and Readme and link to external documents Apr 14, 2015
README.md Update Trusty references to Bionic Feb 23, 2019
Rakefile Ignore checking nip.io link Mar 11, 2019
SUPPORT.md Add a SUPPORT.md file Jul 24, 2017
_config.yml Update Trusty references to Bionic Feb 23, 2019
_lifecycle.json Add a new Lifecycle cleanup rule May 19, 2016
_website.json Fixing redirect failed build issue Apr 27, 2017
codeship-services.yml
codeship-steps.yml revert changes made to codeship-steps.yml Apr 29, 2019
codeship.asc Revert "remove key" Oct 5, 2015
deployment.env.encrypted rotate AWS credentials Nov 27, 2018
dockercfg.encrypted confirmed successful push Apr 29, 2019
feed.xml
google1a85968316265362.html Google back Jul 13, 2017
gulpfile.js Switch to Browserslist for Autoprefixer Jul 1, 2019
index.html fixed focused typo Jul 5, 2018
package.json Bump gulp-jsonlint from 1.3.0 to 1.3.1 Sep 1, 2019
robots.txt Don’t index tag pages Sep 18, 2017
yarn.lock Bump gulp-jsonlint from 1.3.0 to 1.3.1 Sep 1, 2019

README.md

Codeship Documentation Codeship Status for codeship/documentation Dependabot Status

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.

If you have any questions regarding your projects on Codeship, or general features and supported workflows, please take a look at how to get help instead.

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 --rm -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 --rm -v $(pwd):/docs codeship/documentation bundle lock --update

For NPM based dependencies, run the following two commands

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

Spellcheck

To run spellcheck on all Markdown files, run the following command:

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

To run the interactive correction functionality and to update the .spelling file, run:

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

See output and mdspell for details on how to maintain the .spelling file.

Linting

SCSS

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

docker run -it --rm -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 --rm -v $(pwd):/docs codeship/documentation gulp lint

Jekyll

docker run -it --rm -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 Bionic.

{% man_url formatdb %}

generates the following output:

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

Notes

You can include note sections on the pages via the csnote helper. Those blocks are powered by the Shipyard Notes component

{% csnote info %}
Some informational text.
{% endcsnote %}

As an optional argument you can specify either info, success or warning. If you don't specify the argument a default (grey) note will be used.

You can’t perform that action at this time.