factor-io / docs

Factor.io documentation

Factor.io Documentation

Factor.io documentation hosted at http://docs.factor.io/

git clone [email protected]:factor-io/docs
bundle install
bundle exec middlman server

docs's Issues

Add information about status of page

Add Hipchat docs

Last line of step 5 is "In Github change the contents of your file"

Seems incomplete

Add Timer docs

Add Pushover docs

Need Pro/Overview

Add Github docs

Trello documentation

Migrate to middleman

PagerDuty docs incomplete

Validate authentication for each connector

Add link to Github page

Add SSH Docs

Jenkins documentation icomplete

examples need revision for (github in particular)

Add console API docs

Prettify isn't loading

tutorial step 6 is incomplete

Add Heroku docs

Tutum Docs are incomplete

Add favicon

Add Migration guide form Cloud to Core

Add Travis docs

Remove dependency on https://factor.io/assets/*

Currently some styles and images are loaded from https://factor.io/

Add BitBalloon docs

guides/workflows needs revision

Need pro/credentials

Slack docs need revision

Mailgun documentation

Cleanup formatting

• Define all params in tables instead of lists
• When referencing connectors.yml or credentials.yml use '#' instead of '**'
• Make sure to use \n after blocks so next block is formatted
• remove any references to '{{' or '{%'

Github Connector docs are missing info about required permissions

The documentation for Github doesn't explain what credentials you need when creating an Auth token. By default only a few are selected, so docs should say which ones are actually required.

Test and validate self-hosting docs

Creating custom workflows

• Writing tests using spec helpers
• Recommended approach
• Using with connector + cli (update init.rb, run, and use command line to call)

Add a collapsable menu as it is getting large

Connector Wishlish

• Loggly
• Slack

Add Web docs

Cleanup the template

The templates are kind of hacked together.

• remove inline CSS
• remove style blocks and move them to a file
• move the partials to a folder
• use HAML instead of ERB where possible