Maintainer Guide

Atlas Maintainer Guide

Introduction

The Atlas backend can be found at https://atlas-backend.herokuapp.com/. You can get a list of all repositories using the /repos endpoint. You can query repositories by name using the /repos/:title filter. You can sync the backend with the IGME-RIT organization using the /sync endpoint.

Submission Workflow

1. Users will submit an issue to IGME-RIT/contribute proposing a tutorial. Discussion should occur to add more detail to the proposal, outline parameters, and provide the community a chance to shape the result of this request.
2. Users will submit finished tutorials as pull requests to IGME-RIT/ contribute. They should be added to the root directory of the repository. It is very important that you test tutorials before accepting their pull request through manual testing, and automated testing if provided.
3. Accepted pull requests will stage the tutorial in the root directory of IGME-RIT/ contribute. When it's time to add the tutorial to Atlas, you will proceed to the Publishing Workflow

Publishing Workflow

Prerequisites

• You must have a GitHub account
• You must be an admin on the IGME-RIT organization
• You must be in an environment to properly test projects before publishing them.
  • C# - VS2015 or Xamarin Studio 6.0 or later, unless otherwise specified.
  • C++/OpenGL - Windows and VS2015, unless otherwise specified.
  • Web - Google Chrome 49 or later, unless otherwise specified.

Steps

1. Clone IGME-RIT/contribute, or pull down the latest changes if you already have a local copy.

   git clone https://github.com/IGME-RIT/contribute
   cd contribute

2. The tutorial you will be publishing should be in the root directory of the repository. If it isn't, it has either been published already or something has gone wrong in the Submission Workflow. Move it out of the repository into a different location, and commit the changes in the repository.

   mv ./<folder> ../
   git add .
   git commit
   git pull --rebase
   git push origin master 

3. Initialize a new repository inside the tutorial folder

   cd <folder>
   git init
   git status

4. Add an igme_config.yml file to the root of the tutorial folder. For an example of a good configuration file, check out this example.

   series:				# If the tutorial is part of a series, name of the series goes here
   title:				# Full name of tutorial
   author:
   	name:			# Full name of author
   	email:			# Email address
   	github:			# Github username
   description:		# A short description of the tutorial
   language:			# Language the tutorial is written in
   tags: 				# Search keywords
   	-
   	-
   extra_resources:
   	- title:		# Name of the resource
   	  link:			# URL of said resource
   connections:		# Parent connections 
   	- series:		# Series name of parent tutorial
   	  title:		# Repository name of parent tutorial

5. Create a new repository on GitHub under the IGME-RIT organization. Name it so its name is consistent with the other tutorial projects on the organization.

6. Push the tutorial to the remote repository.

   git remote add origin https://github.com/IGME-RIT/<repo name>.git
   git add .
   git commit -m "Initial commit"
   git pull --rebase
   git push origin master

7. Sync the backend with the organization. Click the Login with GitHub button to begin the sync operation.