KittyBot / example-guide

A guide to creating Examples for fly-examples for all potential Fly Writers

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

example-guide - A Guide for Examples

This is a guide to creating Examples for fly-examples for all potential Fly Writers.

Your Repo

Start with your own repository. When the time comes, we'll ask you to transfer it over to us.

The Readme

READMEs in fly-examples should read like an informative article about the example. Why? Well, we use the Readme directly in our publishing system to ensure content is always up to date and avoid there being multiple steps in getting content updated. And because there's nowhere better to keep the content than with the example itself.

Files and Fly files

The repository itself should carry all the example material. If you, for example, have multiple versions of the same file demonstrating different configurations, make sure those versions are available under a meaningful name.

About

A guide to creating Examples for fly-examples for all potential Fly Writers