codeclimate/semaphore-docs-new

Name: semaphore-docs-new

Owner: Code Climate

Description: Documentation site for Semaphore.

Forked from: renderedtext/semaphore-docs-new

Created: 2016-11-10 16:34:12.0

Updated: 2016-11-10 16:34:14.0

Pushed: 2016-11-10 16:36:09.0

Homepage: https://semaphoreci.com/docs

Size: 20743

Language: CSS

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Semaphore Docs

Semaphore Docs, powered by Middleman and Amazon S3.

Setup

Clone the repo and install all necessary gems with

t clone git@github.com:renderedtext/semaphore-docs-new.git
 semaphore-docs-new
ndle install --path .bundle
 data/credentials.yml.example data/credentials.yml

For writing new articles or making updates, feel free to leave dummy credentials in data/credentials.yml.

Writing

Pages are stored in source/docs/.

To view the blog locally run:

rver

which actually runs

ndle exec middleman -p 4000

Now you can open http://localhost:4000/docs.

Categories

Categories will be automatically grabbed from the post heading:

ut: post
e: Custom database.yml
gory: Ruby

If the page /docs/ruby.html exists, user will be able to reach it from the post breadcrumbs. If the page doesn't exist, a page with the list of all posts in the category will be automatically generated and displayed.

Embedding images

All images must be in the PNG file format, and processed using ImageOptim. If you do not have access to an OS X machine, please notify us in the pull request, and we'll make sure to run them through ImageOptim.

Give all images appropriate alt text, as well as the following CSS classes:

 src="/docs/assets/img/2012-06-14/semaphore-homepage.png" alt="Semaphore Homepage" class="img-responsive img-bordered">

Escaping ERB

You must escape ERB code snippets in files with .erb extension (via):

 foo %>

Deployment

for Rendered Text people

Simply run

ploy

which does bundle exec middleman build and uploads the content to an S3 bucket using the AWS CLI. It requires a valid ~/.aws configuration.

Configuration

All sensitive credentials are stored in data/credentials.yml check data/credentials.yml.example for more info about format of file.

Importing content from Semaphore Blog

If you turn a blog post into a Semaphore Docs page you should include the canonical url in the post meta data. For more info, visit the Semaphore Blog guidelines.