Git Product home page Git Product logo

www.aptible.com's Introduction

Build Status

Aptible's public web site is built with Middleman.

Running Locally

Clone the repo:

git clone https://github.com/aptible/www.aptible.com.git
cd www.aptible.com/

Install necessary dependencies:

bundle install
cd aptiblejs
npm install

(Optionally) pull dynamic Resource and Blog content from Contentful:

bundle exec rake contentful:pull

Start the server. You can access it at http://localhost:4567/

bundle exec middleman server
cd aptiblejs
npm run dev

If you are running Aptible's documentation site locally, set the BASE_DOC_URL environment variable:

BASE_DOC_URL=http://localhost:8888 bundle exec middleman server

Deploying Code Changes

First, some prerequisites:

  • AWS CLI, installed locally
  • A valid AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY in your environment

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

To manually deploy to production, using Omnivault:

omnivault exec bundle exec rake deploy:production

Staging:

omnivault exec bundle exec rake deploy:staging

An arbitrary S3 bucket:

omnivault exec bundle exec rake deploy[bucket]

Deploying Content Changes

To deploy content-only changes, make sure your changes are set to published in Contentful and then deploy manually from Travis:

Continuous Deployment

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/www --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.

Copyright

Copyright (c) 2019 Aptible. All rights reserved.

www.aptible.com's People

Contributors

gib avatar chasballew avatar skylar-anderson avatar mjp avatar krallin avatar henryhund avatar moeamaya avatar aptible-robot avatar blakepettersson avatar rwjblue avatar shahkader avatar elving avatar michaelscottlyons avatar usernotfound avatar mixonic avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.