JavaScript HTML Other
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
.github PR checklist May 31, 2016
_bin Add Travis CI badge, and don't check external links for now Jan 19, 2017
_config fix cli download links May 24, 2018
_console fix links Mar 28, 2018
_deployment note that 401s are allowed for health checks Jul 5, 2018
_development fix cli installation references May 23, 2018
_gen1 fix links Mar 28, 2018
_help gen2 default Mar 27, 2018
_includes blog extras sidebar layout and social buttons payload Apr 4, 2017
_integrations fix links Mar 28, 2018
_introduction fix cli installation references May 23, 2018
_layouts routersecuritygroup docs Apr 3, 2018
_management filter example Jul 13, 2018
_monitoring Use info callouts instead of warnings Feb 15, 2017
_posts remove two outdated blog posts Dec 14, 2017
_reference fix uninstall instructions Jul 18, 2018
_resources fix links Mar 27, 2018
api fix links Mar 28, 2018
assets syntax highlighting Mar 22, 2018
automation Prep for release Apr 4, 2017
blog blog extras sidebar layout and social buttons payload Apr 4, 2017
cases add comparison link to index Apr 4, 2017
docs serve static files with nginx in prep for github pages replacement (#126 Apr 20, 2016
enterprise add danone case study May 2, 2017
error Integrate site redesign from Formed Jan 18, 2017
how how it works content Apr 4, 2017
jobs Add Kansas City to distributed team locations. Nov 15, 2016
legal fix updated date Mar 15, 2017
pci Prep for release Apr 4, 2017
pricing add workflow concurrency to pricing page Jun 20, 2018
reinvent Prep for release Apr 4, 2017
team fix overlapping on team site Jan 27, 2017
.dockerignore Add *.swp to .dockerignore; pin repo to convox/staging rack. Mar 31, 2017
.gitignore Ignore .jekyll-metadata Feb 23, 2017
.travis.yml disable install Jul 27, 2017
Dockerfile fix gemfile caching Mar 22, 2018
Gemfile Put algolia search in docs header instead of base header. Cry because… Nov 22, 2016
Gemfile.lock update nokogiri Mar 22, 2018
LICENSE Initial commit Aug 9, 2015
Makefile Add script to test site for broken links; run with 'make test' Jan 17, 2017
README.md Add Travis CI badge, and don't check external links for now Jan 19, 2017
_config.yml gen2 default Mar 27, 2018
convox.yml fix convox.yml Nov 3, 2017
docker-compose.yml Exclude vendor in _config.yml as per jekyll/jekyll#2938 Jan 18, 2017
favicon.ico Merge party (#145) Apr 29, 2016
index.html default cost is in flux, this is fairly out of date Apr 16, 2018
search.json add Simple-Jekyll-Search Aug 24, 2015

README.md

Convox Docs

Build Status

This repo contains the source files for convox.com.

Documentation is written in Markdown (with options similar to Github's Flavor).

Jekyll is used to generate static HTML files.

Please let us know about any issues, either via issues or by emailing support@convox.com

Pull requests are also welcome!

Usage

Convox and Docker are recommended.

$ git clone https://github.com/convox/site.git && cd site
$ echo DEVELOPMENT=true >> .env
$ convox start

Running directly on your host

Ruby and bundler are required.

$ bundle install
$ jekyll serve
==    Server address: http://127.0.0.1:4000/

Please send updates to documentation as Pull Requests.

Frontmatter

Each page in the documentation has a header, called frontmatter. This controls where it's displayed and its title.

e.g.

---
title: "Custom Domains"
sort: 40
---

Publishing

When a pull request is merged into the master branch of this repo, the change is automatically deployed to staging.

Then, once one of the maintainers of this repo promotes the release on the Convox production rack, it will be visible on convox.com.