Docs and discussion about ATS software delivery culture and practices.
We want everyone at ATS to contribute to the discussion about how we build software!
Please fork the repo or create a branch, make changes, and submit a pull request to get your ideas reviewed by other developers.
Once you've made all the edits you'd like, push your branch and submit a pull request. Once your pull request has been reviewed
and discussed by the team, you should get a or two indicating that it's ready to go. At that point, merge the branch into
and the Travis build will automatically re-deploy the site to gh-pages.
The workflow of branching, submitting a PR, then merging is covered more thoroughly in our GitHub guide.
The 'guides' are individual pages that describe some aspect of how we deliver software and services to our customers.
*.md files in the root are the guide pages. The home page automatically pulls in all of these pages and displays them in the list.
If you want to edit an existing page, simply work on it in your favorite editor.
If you want to add a new guide page, add a new
*.md file to the project root, and then insert the yaml header material.
You can use one of the other pages as a template, but at a minimum you'll need the title, description, and permalink fields.
If you want to do deeper work on the site's structure or design, have a look at the Jekyll docs to understand how the content is set up.
We use Jekyll to streamline the installation so you can run the site locally to make sure any changes will look ok when deployed.
If you do not have Jekyll installed:
- You must first install Ruby using
brew install ruby. This will install it globally.
sudo gem install jekyll
- Start jekyll:
- View the site on your host machine: http://localhost:4000/guides/
Deployment uses a gulp task to push to
gh-pages, where it can be viewed at http://labs.atsid.com/guides/.
- Get dev dependencies:
- Install gulp if you don't have it:
npm install -g gulp
Note again that this process happens automatically by Travis whenever commits are made to master.