Aptible's Support and Documentation Site
First, clone the repo:
git clone https://github.com/aptible/support.git
cd support/
Then, install necessary dependencies:
bower install
bundle install
Finally, start the server. You can access it at http://localhost:4567/
bundle exec middleman server
First, some prerequisites:
- AWS CLI, installed locally
- A valid
AWS_ACCESS_KEY_ID
andAWS_SECRET_ACCESS_KEY
in your environment
In production and staging, the support site is deployed as an S3 website (fronted by CloudFront).
To manually deploy to production, using Omnivault:
eval $(aws-creds env default) && bundle exec rake deploy:production
Staging:
eval $(aws-creds env default) && bundle exec rake deploy:staging
An arbitrary S3 bucket:
eval $(aws-creds env default) && bundle exec rake deploy[bucket]
Travis CI deploys to both 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=...
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.
- Skylar Anderson (@sandersonet)
- Chas Ballew (@chasballew)
- Frank Macreery (@fancyremarker)
- Wayne Chang (@wyc)
Copyright (c) 2016 Aptible. All rights reserved.