Merge pull request #265 from bkuhlmann/toc

Added README Table of Contents

Gemfile

@@ -73,5 +73,7 @@ group :development do
   gem 'spring'
   gem 'spring-commands-rspec'
   gem 'spring-watcher-listen', '~> 2.0'
+  gem 'tocer', '~> 9.1'
   gem 'web-console', '~> 3.0'
 end
+

Gemfile.lock

@@ -248,6 +248,7 @@ GEM
       ffi (~> 1.0)
     rdoc (4.3.0)
     redis (3.3.5)
+    refinements (6.3.1)
     responders (3.0.0)
       actionpack (>= 5.0)
       railties (>= 5.0)
@@ -287,6 +288,9 @@ GEM
     ruby-progressbar (1.10.0)
     ruby_dep (1.5.0)
     ruby_http_client (3.3.0)
+    runcom (5.0.2)
+      refinements (~> 6.0)
+      xdg (~> 3.0)
     safe_yaml (1.0.5)
     sass (3.7.3)
       sass-listen (~> 4.0.0)
@@ -344,6 +348,10 @@ GEM
     thread_safe (0.3.6)
     tilt (2.0.9)
     timecop (0.9.1)
+    tocer (9.1.1)
+      refinements (~> 6.0)
+      runcom (~> 5.0)
+      thor (~> 0.20)
     turbolinks (5.2.0)
       turbolinks-source (~> 5.2)
     turbolinks-source (5.2.0)
@@ -367,6 +375,7 @@ GEM
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.3)
     will_paginate (3.1.6)
+    xdg (3.0.2)
     xpath (3.2.0)
       nokogiri (~> 1.8)
 
@@ -429,6 +438,7 @@ DEPENDENCIES
   sprockets
   textacular (~> 5.0)
   timecop
+  tocer (~> 9.1)
   turbolinks (~> 5.x)
   uglifier
   web-console (~> 3.0)

README.md

@@ -1,5 +1,39 @@
 # New Sanctuary Coalition
 
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+## Table of Contents
+
+  - [What are we building?](#what-are-we-building)
+  - [Getting setup](#getting-setup)
+    - [System Dependencies](#system-dependencies)
+    - [Environment Variables](#environment-variables)
+    - [Using Docker to Run the Application (optional)](#using-docker-to-run-the-application-optional)
+    - [Ruby Dependencies](#ruby-dependencies)
+    - [Database installation](#database-installation)
+      - [1. Mac OS](#1-mac-os)
+      - [2. All non-Mac OS](#2-all-non-mac-os)
+    - [Database setup](#database-setup)
+  - [Running the test suite](#running-the-test-suite)
+  - [Running the App Locally](#running-the-app-locally)
+  - [User Roles](#user-roles)
+      - [Regional Admin (has access to all communities within their regions)](#regional-admin-has-access-to-all-communities-within-their-regions)
+      - [Community Admin Role (has access to everything scoped to their Community)](#community-admin-role-has-access-to-everything-scoped-to-their-community)
+      - [Community Volunteer Role (has limited access to their community)](#community-volunteer-role-has-limited-access-to-their-community)
+      - [Community Accompaniment Leader Role (only applicable to Primary communities)](#community-accompaniment-leader-role-only-applicable-to-primary-communities)
+      - [Remote Clinic Lawyer Role](#remote-clinic-lawyer-role)
+  - [How are we building it?](#how-are-we-building-it)
+    - [Test Coverage!](#test-coverage)
+    - [Staging App](#staging-app)
+    - [Performance Monitoring](#performance-monitoring)
+  - [Maintenance](#maintenance)
+  - [Contributing](#contributing)
+  - [Code of Conduct](#code-of-conduct)
+  - [Questions?](#questions)
+  - [Contributors](#contributors)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
 ## What are we building?
 
 The New Sanctuary Coalition is a network of congregations, organizations, and individuals standing publicly in solidarity with families and communities resisting detention and deportation. This internal database software facilitates NSC's core programs and allows them to operate at increasing scale.
@@ -182,6 +216,14 @@ The data is refeshed occassionally, but activities/accompaniments are likely to
 We are using Skylight for performance monitoring.
 [![View performance data on Skylight](https://badges.skylight.io/status/jaU6phtJKOvV.svg)](https://oss.skylight.io/app/applications/jaU6phtJKOvV)
 
+## Maintenance
+
+When making changes to the README of this project, make sure to run the following:
+
+    rake toc
+
+This will ensure the Table of Contents for this project is properly updated.
+
 ## Contributing
 1. Add a comment on your chosen Github issue to let other contributors know that you have 'claimed' it.
 2. Fork the repo and download a clone of the forked repo: https://guides.github.com/activities/forking/

Rakefile

@@ -4,3 +4,11 @@
 require File.expand_path('config/application', __dir__)
 
 Rails.application.load_tasks
+
+if Rails.env.development?
+  begin
+    require "tocer/rake/setup"
+  rescue LoadError => error
+    puts error.message
+  end
+end