Skip to content
Content for the Shotgun Developer site.
Branch: master
Clone or download
willis102 SG-11206 Add Pipeline Tutorial (#44)
Add Pipeline Tutorial and restructure TOC.
Latest commit 7a99cb8 Mar 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
tk-doc-generator @ 61f64bc SG-11206 Add Pipeline Tutorial (#44) Mar 15, 2019
.gitmodules
.travis.yml
LICENSE.md Initial Content (#1) Jan 25, 2019
README.md Updated Readme Feb 20, 2019
jekyll_config.yml
pr.png Improved the README file (#4) Jan 28, 2019

README.md

Build Status Doc Generator

developer.shotgunsoftware.com

Welcome to the source repository for developer.shotgunsoftware.com. This repository holds the markdown source and configuration used to generate the Shotgun developer site.

How does it work?

The Shotgun Developer site uses continous integration. What you see in the master branch of this repository is reflected on the developer website. You create github issues and pull requests in order to make changes to the Repository.

The site uses the Toolkit Documentation Generation system to convert markdown, sphinx and other content to a website, complete with search, table of contents etc.

Making a change to the documentation

If you want to make a change to the content on the developer site, please work in a branch in github and submit a pull request.

Formatting and style

For documentation on syntax and formatting guidelines, please see the style guide that comes with the documentation generation system.

Site Preview

Once you have created a pull request, the system will automatically generate a preview of the full site for every change you make, making it easy to see what your changes will look like before they are released.

Documentation Review

Once you have submitted a pull request, it will be reviewed and merged by our team. Once merged, it will become part of the official documentation.

Merging with master

When code is merged into master, make sure to put in a meaningful title and description, and include the pull request id. For example:

PR

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.