aaw / support

Aptible's Support and Documentation Site

Aptible Support

Aptible's Support and Documentation Site

Running Locally

First, clone the repo:

git clone https://github.com/aptible/aptible-docs.git
cd aptible-docs/

Then, install necessary dependencies:

bower install
bundle install

Finally, start the server. You can access it at http://localhost:4567/

bundle exec middleman server

Deploying

First, some prerequisites:

• AWS CLI, installed locally
• Access to a sufficiently authorized pair of AWS access key credentials

In production and staging, the support site is deployed as an S3 website (fronted by CloudFront).

To deploy to production:

bundle exec rake deploy:production

To deploy to staging:

bundle exec rake deploy:staging

To deploy to an arbitrary S3 bucket:

bundle exec rake deploy[bucket]

Note that deployment happens automatically (both to staging and production) on every successful merge to master. This requires the encrypted AWS credentials for an authorized user to be stored in the .travis.yml configuration file.

To update these credentials at any time, run:

travis encrypt -r aptible/support --add env AWS_ACCESS_KEY_ID=... AWS_SECRET_ACCESS_KEY=...

Contributing

If you run into an issue that needs documentation, feel free to submit a pull request or open an issue. We send t-shirts and swag to contributors.

Contributors

• Skylar Anderson (@sandersonet)
• Chas Ballew (@chasballew)
• Frank Macreery (@fancyremarker)
• Wayne Chang (@wyc)

Copyright

Copyright (c) 2015 Aptible. All rights reserved.