ascii_binder_gabriel_rh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56fae4193af226b850e7d7d52731a13aa92c28af24d020ab07b4ca0cf10b0769
+  data.tar.gz: 191fa63cc8e86d8da56a4b6b1f93eedb1d2e994e53611188a4a76e3495f35fbe
+SHA512:
+  metadata.gz: 7e6858bab2a8fafe952da235508949ff207ff3fe4e78c7dffb4ad68f77112d28077b5ee9cbade6c14baa95e283109e0c9bada1d02353e792071ffdda51f5e96c
+  data.tar.gz: d9f3d81ca8f1615356603b8d487cecd50a74df0f9fec36d82174b6fe550338c5d4230fd3881f4de879c012ab238dae869e08c2cf52d82cf31b50e2840ba6d570

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Dockerfile

@@ -0,0 +1,19 @@
+FROM centos/ruby-23-centos7
+
+RUN scl enable rh-ruby23 -- gem install listen -v 3.0.8
+RUN scl enable rh-ruby23 -- gem install ascii_binder_gabriel_rh
+USER root
+RUN yum install -y java-1.7.0-openjdk && \
+    yum clean all
+
+LABEL url="http://www.asciibinder.org" \
+      summary="a documentation system built on Asciidoctor" \
+      description="AsciiBinderGabrielRH is for documenting versioned, interrelated projects. Run this container image from the documentation repository, which is mounted into the container. Note: Generated files will be owned by root." \
+      RUN="docker run -it --rm \
+          -v `pwd`:/docs:z \
+          IMAGE"
+
+ENV JAVA_HOME=/usr/lib/jvm/java-1.7.0-openjdk-1.7.0.95-2.6.4.0.el7_2.x86_64/jre/
+ENV LANG=en_US.UTF-8
+WORKDIR /docs
+CMD asciibinder package

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,3 @@
+require 'ascii_binder_gabriel_rh'
+gem_dir = Gem::Specification.find_by_name("ascii_binder_gabriel_rh").lib_dirs_glob
+instance_eval(File.read(File.join(gem_dir, 'ascii_binder_gabriel_rh/tasks/guards.rb')))

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Red Hat, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,21 @@
+= AsciiBinderGabrielRH
+
+image:https://badge.fury.io/rb/ascii_binder_gabriel_rh.svg["Gem Version", link="https://badge.fury.io/rb/ascii_binder_gabriel_rh"]
+
+AsciiBinderGabrielRH is an AsciiDoc-based system for authoring and publishing closely related documentation sets from a single source.
+
+This product is no longer actively maintained.
+
+== Learn More
+
+* Take the https://rubygems.org/gems/ascii_binder_gabriel_rh[ascii_binder_gabriel_rh Ruby Gem] for a spin.
+
+The AsciiBinderGabrielRH system was initially developed for https://github.com/openshift/openshift-docs[OpenShift documentation], but has been revised to work for documenting a wide variety of complex, multi-versioned software projects.
+
+== Contributing
+
+We are using the https://github.com/redhataccess/ascii_binder_gabriel_rh/issues[Issues] page to track bugs and feature ideas on the code, so have a look and feel free to ask questions there.
+
+== License
+
+The gem is available as open source under the terms of the http://opensource.org/licenses/MIT[MIT License].

data/README.md

@@ -0,0 +1 @@
+# asciibinder-gabriel-rh

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ascii_binder_gabriel_rh.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ascii_binder_gabriel_rh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ascii_binder_gabriel_rh"
+  spec.version       = AsciiBinderGabrielRH::VERSION
+  spec.authors       = ["N. Harrison Ripps", "Jason Frey", "Carlos Munoz", "Brian Exelbierd", "Vikram Goyal"]
+  spec.email         = ["nhr@redhat.com", "jfrey@redhat.com", "chavo16@hotmail.com", "bex@pobox.com", "vigoyal@redhat.com"]
+  spec.summary       = %q{AsciiBinderGabrielRH is an AsciiDoc-based system for authoring and publishing closely related documentation sets from a single source.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/redhataccess/ascii_binder_gabriel_rh"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "cucumber", "~> 2.3.3"
+  spec.add_development_dependency "diff_dirs", "~> 0.1.2"
+  spec.add_dependency "rake", "~> 12.3.3"
+
+  spec.add_dependency 'asciidoctor', '~> 2.0.10'
+  spec.add_dependency 'asciidoctor-diagram', '~> 2.0.2'
+  spec.add_dependency 'rouge', '~> 3.18.0'
+  spec.add_dependency 'git'
+  spec.add_dependency 'guard'
+  spec.add_dependency 'guard-shell'
+  spec.add_dependency 'guard-livereload'
+  spec.add_dependency 'haml'
+  spec.add_dependency 'json'
+  spec.add_dependency 'sitemap_generator', '~> 6.0.1'
+  spec.add_dependency 'trollop', '~> 2.1.2'
+  spec.add_dependency "yajl-ruby", ">= 1.4.2"
+  spec.add_dependency 'tilt'
+  spec.add_dependency 'asciidoctor-fixxrefs'
+  
+end

data/bin/ascii_binder_gabriel_rh

@@ -0,0 +1 @@
+bin/asciibinder_gabriel_rh

data/bin/asciibinder_gabriel_rh

@@ -0,0 +1,350 @@
+#!/usr/bin/env ruby
+
+require 'ascii_binder_gabriel_rh/distro_map'
+require 'ascii_binder_gabriel_rh/engine'
+require 'ascii_binder_gabriel_rh/helpers'
+require 'ascii_binder_gabriel_rh/version'
+require 'pathname'
+require 'trollop'
+
+include AsciiBinderGabrielRH::Engine
+include AsciiBinderGabrielRH::Helpers
+
+def call_generate(branch_group, distro, page)
+  if page == ''
+    page = nil
+  end
+  begin
+    generate_docs(branch_group, distro, page)
+  rescue => e
+    message = "#{e.class.name}: #{e.message} at\n    #{e.backtrace.join("\n    ")}"
+    Trollop::die "Could not generate docs:\n#{message}"
+  end
+end
+
+def repo_check(docs_basedir)
+  missing_files = false
+  # These must all be present
+  ['_distro_map.yml','_templates'].each do |file|
+    unless File.exist?(File.join(docs_basedir, file))
+      missing_files = true
+    end
+  end
+  # Either of these must be present
+#  unless File.exist?(File.join("#{docs_basedir}/#{TOPIC_MAP_FOLDER}", '_topic_map.yml'))
+#    missing_files = true
+#  end
+  if missing_files or not in_git_repo(docs_basedir)
+    Trollop::die "The specified docs base directory '#{docs_basedir}' does not appear to be part of an AsciiBinderGabrielRH-compatible repo."
+  end
+end
+
+def in_git_repo(dir)
+  git_path = File.join(dir,'.git')
+  return true if File.exist?(git_path) and File.directory?(git_path)
+  return false if dir == '/'
+  in_git_repo(File.expand_path('..',dir))
+end
+
+SUB_COMMANDS = %w{help version build watch package clean create clone}
+Trollop::options do
+  version AsciiBinderGabrielRH::VERSION
+  banner <<-EOF
+Usage:
+  #$0 <command> <docs_basedir>
+
+Commands:
+  build (default action)
+    Builds the HTML docs within the indicated docs base directory
+  create
+    Generates a new AsciiBinderGabrielRH repo at the indicated dir
+  clone
+    Clones an existing AsciiBinderGabrielRH repo to the local filesystem
+  watch
+    Starts Guard, which automatically regenerates changed HTML
+    files on the working branch in the docs base directory dir
+  package
+    Builds and packages the static HTML for all of the sites
+    defined in the _distro_config.yml file
+  clean
+    Remove _preview, _publish and _package dirs created by
+    other AsciiBinderGabrielRH operations.
+
+Options:
+EOF
+  stop_on SUB_COMMANDS
+end
+
+cmd = ARGV.shift
+docs_basedir = nil
+
+if cmd.nil?
+  cmd = "build"
+elsif !SUB_COMMANDS.include?(cmd)
+  if ARGV.empty?
+    docs_basedir = Pathname.new(cmd)
+    cmd = "build"
+  else
+    Trollop::die "'#{cmd}' is not a valid asciibinder subcommand. Legal values are '#{SUB_COMMANDS.join('\', \'')}'."
+  end
+end
+
+cmd_opts = case cmd
+  when "build"
+    Trollop::options do
+      banner <<-EOF
+Usage:
+  #$0 build <options> <docs_basedir>
+
+Description:
+  This is the default behavior for the asciibinder utility. When run,
+  AsciiBinderGabrielRH reads the _distro_config.yml file out of the working
+  branch of the indicated docs base directory and based on that, proceeds
+  to build the working branch version of the documentation for each distro.
+
+  If you use the --all_branches flag, AsciiBinderGabrielRH behaves as described
+  above, and then once the working branch version is built, AsciiBinderGabrielRH
+  cycles through the other branches named in the _distro_config.yml file
+  until all of the permutations have been built.
+
+  If you want to limit the scope of the build work for faster builds,
+  you have two targeted options:
+
+  --distro=<distro_key> - Only builds the specified distro and branches
+  associated with this distro.
+
+  --page=<page_path> - Only builds the specified page for all distros.
+
+  Note that the format for the "--page" option is:
+
+  <topic_group>:<topic_file>
+
+  or for subtopics:
+
+  <topic_group>/<subtopic_group>:<topic_file>
+
+  However, if you want to use the --page option extensively, then be
+  aware of the `asciibinder watch` function, which does this for you
+  automatically as you change any .adoc files in your working branch.
+
+Options:
+EOF
+      opt :all_branches, "Instead of building only the current working branch, build all branches", :default => false
+      opt :distro, "Instead of building all distros, build branches only for the specified distro.", :default => ''
+      opt :page, "Build only the specified page for all distros and only the current working branch.", :default => ''
+      opt :log_level, "Set the logging output level for this operation.", :default => 'warn'
+      opt :toc_depth, "Maximum depth of topics allowed.  Use 0 for infinite depth.", :default => 3
+      conflicts :distro, :page
+    end
+  when "create"
+    Trollop::options do
+      banner <<-EOF
+Usage:
+  #$0 create <new_docs_basedir>
+
+Description:
+  Creates a new, bare AsciiBinderGabrielRH repo in the specified directory.
+EOF
+    end
+  when "clone"
+    Trollop::options do
+      banner <<-EOF
+Usage:
+  #$0 clone <options> <git_repo_url>
+
+Description:
+  Clones an existing AsciiBinderGabrielRH repo to the current directory.
+  Under the default behavior, AsciiBinderGabrielRH will attempt to set up
+  tracking branches based on the contents of _distro_map.yml,
+  but this can be suppressed (see Options).
+
+Options:
+EOF
+      opt :branches, "Create tracking branches after cloning.", :default => true
+      opt :dir, "Specify the pathname of the local directory for cloning.", :default => ''
+      opt :log_level, "Set the logging output level for this operation.", :default => 'warn'
+    end
+  when "watch"
+    Trollop::options do
+      banner <<-EOF
+Usage:
+  #$0 watch <docs_basedir>
+
+Description:
+  In watch mode, AsciiBinderGabrielRH starts a Guard process in the foreground.
+  This process watches the docs_basedir for changes to the AsciiDoc (.adoc)
+  files. When a change occurs, AsciiBinderGabrielRH regenerates the specific
+  HTML output of the file that was changed, for the working branch only.
+
+  This is the equivalent of running:
+
+  $ asciibinder build --page='<topic_group>:<affected_file>'
+
+  ...except that the Guardfile automatically detects and runs this as
+  you work.
+
+  This is meant to be used in conjunction with a web browser that is viewing the
+  output HTML page. Every time you save a new version of the .adoc file, you can
+  manually refresh your page to view the newly-generated HTML.
+EOF
+      opt :log_level, "Set the logging output level for this operation.", :default => 'warn'
+    end
+  when "package"
+    Trollop::options do
+      banner <<-EOF
+Usage:
+  #$0 package <options> <docs_basedir>
+
+Description:
+  Publish mode is similar to 'build' mode, but once all of the branches' of
+  HTML are generated, 'publish' goes on to organize the branch / distro
+  combinations that are described in _distro_config.yml into their "site"
+  layouts. As a final step, the site layouts are tarred and gzipped for
+  easy placement onto a production web server.
+
+Options:
+EOF
+      opt :site, "Instead of packaging every docs site, package the specified site only.", :default => ''
+      opt :log_level, "Set the logging output level for this operation.", :default => 'warn'
+      opt :toc_depth, "Maximum depth of topics allowed.  Use 0 for infinite depth.", :default => 3
+    end
+  when "help"
+    Trollop::educate
+  when "version"
+    puts AsciiBinderGabrielRH::VERSION
+    exit 0
+  end
+
+if (not docs_basedir.nil? and not ARGV.empty?) or (docs_basedir.nil? and ARGV.length > 1)
+  Trollop::die "Too many arguments provided to ascii_binder_gabriel_rh: '#{ARGV.join(' ')}'. Exiting."
+elsif docs_basedir.nil?
+  if ARGV.length == 1
+    if cmd == 'clone'
+      cmd_opts[:giturl] = ARGV.shift
+      if cmd_opts[:dir] != ''
+        docs_basedir = Pathname.new(cmd_opts[:dir])
+      else
+        docs_basedir = Pathname.new(File.join(Pathname.pwd, cmd_opts[:giturl].split('/')[-1].split('.')[0]))
+      end
+    else
+      docs_basedir = Pathname.new(ARGV.shift)
+    end
+  else
+    if cmd != 'create'
+      if cmd == 'clone'
+        Trollop::die "Provide a git URL to clone from."
+      else
+        docs_basedir = Pathname.pwd
+      end
+    else
+      Trollop::die "Specify a name for the new repo directory."
+    end
+  end
+end
+
+# Validate the docs_basedir path
+if cmd == 'create' or cmd == 'clone'
+  if docs_basedir.exist?
+    Trollop::die "The specified new repo directory '#{docs_basedir}' already exists."
+  end
+else
+  if !docs_basedir.exist?
+    Trollop::die "The specified docs directory '#{docs_basedir}' does not exist."
+  elsif !docs_basedir.directory?
+    Trollop::die "The specified docs directory path '#{docs_basedir}' is not a directory."
+  elsif !docs_basedir.readable?
+    Trollop::die "The specified docs directory '#{docs_basedir}' is not readable."
+  elsif !docs_basedir.writable?
+    Trollop::die "The specified docs directory '#{docs_basedir}' cannot be written to."
+  else
+    repo_check(docs_basedir)
+  end
+end
+
+# Set the repo root
+set_docs_root_dir(File.expand_path(docs_basedir))
+
+# Set the log level
+user_log_level = :warn
+unless cmd_opts.nil? or cmd_opts[:log_level].nil?
+  user_log_level = cmd_opts[:log_level].to_sym
+  unless log_levels.has_key?(user_log_level)
+    Trollop::die "log_level value '#{cmd_opts[:log_level]}' is not recognized. Legal values are " + log_levels.keys.map{ |lvl| "'#{lvl.to_s}'" }.join(', ')
+  end
+end
+set_log_level(user_log_level)
+
+# Set the depth level
+user_depth = 3
+unless cmd_opts.nil? or cmd_opts[:toc_depth].nil?
+  user_depth = cmd_opts[:toc_depth].to_i
+end
+set_depth(user_depth)
+
+
+# Cloning? Time to try it.
+if cmd == 'clone'
+  puts "Cloning #{cmd_opts[:giturl]} to #{docs_basedir}"
+  system("git clone #{cmd_opts[:giturl]} #{docs_basedir}")
+  Trollop::die "The git URL could not be cloned: #{err}" if $?.exitstatus != 0
+
+  # Make sure this cloned repo is legit.
+  repo_check(docs_basedir)
+
+  if cmd_opts[:branches]
+    cloned_map = AsciiBinderGabrielRH::DistroMap.new(File.join(docs_basedir,DISTRO_MAP_FILENAME))
+    unless cloned_map.is_valid?
+      error_info = cloned_map.errors.join("\n")
+      Trollop::die "The distro map in the newly cloned repo is invalid, with the following errors:\n#{error_info}"
+    end
+    Dir.chdir(docs_basedir)
+    puts "Tracking branch setup:"
+    cloned_map.distro_branches.each do |doc_branch|
+      next if doc_branch == 'main'
+      puts "- #{doc_branch}"
+      system("git branch #{doc_branch} origin/#{doc_branch}")
+    end
+  else
+    puts "- Skipping tracking branch setup"
+  end
+
+  # Done and done.
+  puts "Cloning complete."
+  exit
+end
+
+# Change to the repo dir. This is necessary in order for
+# AsciiDoctor to work properly.
+if cmd != 'create'
+  Dir.chdir docs_basedir
+end
+
+# Do the things with the stuff
+case cmd
+when "build"
+  branch_group = cmd_opts[:all_branches] ? :all : :working_only
+  build_distro = cmd_opts[:distro] || ''
+  refresh_page = cmd_opts[:page] || nil
+  call_generate(branch_group,build_distro,refresh_page)
+when "package"
+  clean_up
+  package_site = cmd_opts[:site] || ''
+  branch_group = package_site == '' ? :publish : "publish_#{package_site}".to_sym
+  call_generate(branch_group,'',nil)
+  package_docs(package_site)
+when "watch"
+  if !dir_empty?(preview_dir)
+    guardfile_path = File.join(Gem::Specification.find_by_name("ascii_binder_gabriel_rh").full_gem_path, 'Guardfile')
+    exec("guard -G #{guardfile_path}")
+  else
+    Trollop::die "Run 'asciibinder build' at least once before running 'asciibinder watch'."
+  end
+when "clean"
+  clean_up
+  puts "Cleaned up #{docs_basedir}."
+when "create"
+  create_new_repo
+  puts "Created new repo in #{docs_basedir}."
+end
+
+exit

data/features/command_help.feature

@@ -0,0 +1,8 @@
+Feature: asciibinder help
+
+  Displays help information for the asciibinder utility
+
+  Scenario: A user wants to see help information for the utility
+    Given a nonexistent repo directory
+    When the user runs `asciibinder help` on that repo directory
+    Then the program displays help information

data/features/command_version.feature

@@ -0,0 +1,8 @@
+Feature: asciibinder version
+
+  This command returns the version of the installed utility
+
+  Scenario: A user wants to display the version of the asciibinder utility
+    Given a nonexistent repo directory
+    When the user runs `asciibinder version` on that repo directory
+    Then the program prints the current version of the utility

data/features/repo_build.feature

@@ -0,0 +1,39 @@
+Feature: asciibinder build
+
+  Causes the utility to process one or more distro/branch combinations,
+  transforming AsciiDoc files to a unified docs set in HTML
+
+  Scenario: A user wants to do any build in a repo with an invalid distro map
+    Given an invalid AsciiBinderGabrielRH docs repo due to a malformed distro map
+    When the user runs `asciibinder build` on that repo directory
+    Then the program exits with a warning
+
+  Scenario: A user wants to build all distros against the current repo branch
+    Given a valid AsciiBinderGabrielRH docs repo with multiple distros
+    When the user runs `asciibinder build` on that repo directory
+    Then the program generates preview content for all distros in the current branch
+
+  Scenario: A user wants to do a build in a repo with alias that points to a nonexistent topic
+    Given a valid AsciiBinderGabrielRH docs repo with an invalid alias
+    When the user runs `asciibinder build` on that repo directory
+    Then the program exits with a warning
+
+  Scenario: A user wants to build a single distro against the current repo branch
+    Given a valid AsciiBinderGabrielRH docs repo with multiple distros
+    When the user runs `asciibinder build --distro=distro_test` on that repo directory
+    Then the program generates preview content for only the `distro_test` distro
+
+  Scenario: A user wants to build all distros against all relevant branches
+    Given a valid AsciiBinderGabrielRH docs repo with multiple distros
+    When the user runs `asciibinder build --all-branches` on that repo directory
+    Then the program generates preview content for all relevant distro/branch combos
+
+  Scenario: A user wants to build a specific page in the current branch
+    Given a valid AsciiBinderGabrielRH docs repo with multiple distros
+    When the user runs `asciibinder build --page=welcome:index` on that repo directory
+    Then the program generates preview content for the specified page in all distros
+
+  Scenario: A user wants to build from a repo where the docs root is not the repo root
+    Given a valid AsciiBinderGabrielRH docs repo where the docs root is not at the repo root
+    When the user runs `asciibinder build` on that docs root directory
+    Then the program generates preview content for all distros in the current branch

data/features/repo_clean.feature

@@ -0,0 +1,20 @@
+Feature: asciibinder clean
+
+  This command cleans up any files generated by AsciiBinderGabrielRH
+
+  Scenario: A user wants to clean a docs repo of generated content
+    Given a valid AsciiBinderGabrielRH docs repo
+    And the docs repo contains generated content
+    When the user runs `asciibinder clean` on that repo directory
+    Then the generated content is removed
+
+  Scenario: A user cleans a docs repo with no generated content
+    Given a valid AsciiBinderGabrielRH docs repo
+    And the docs repo contains no generated content
+    When the user runs `asciibinder clean` on that repo directory
+    Then the program exits without errors
+
+  Scenario: A user cleans a directory that is not a docs repo
+    Given an invalid AsciiBinderGabrielRH docs repo
+    When the user runs `asciibinder clean` on that repo directory
+    Then the program exits with a warning

data/features/repo_clone.feature

@@ -0,0 +1,22 @@
+Feature: asciibinder clone
+
+  This command clones a remote docs repo to a local directory and
+  sets up tracking branches for each branch listed in the distro map
+
+  Scenario: A user tries to clone a nonexistent remote repo
+    Given a nonexistent remote repo
+    And a nonexistent repo directory
+    When the user runs `asciibinder clone` on that repo directory
+    Then the program exits with a warning
+
+  Scenario: A user tries to clone a remote repo into an existing directory
+    Given an existing remote repo
+    And an existing repo directory
+    When the user runs `asciibinder clone` on that repo directory
+    Then the program exits with a warning
+
+  Scenario: A user tries to clone a remote repo into a nonexistent directory
+    Given an existing remote repo
+    And a nonexistent repo directory
+    When the user runs `asciibinder clone` on that repo directory
+    Then the program clones the remote repo into the local directory

data/features/repo_create.feature

@@ -0,0 +1,13 @@
+Feature: asciibinder create
+
+  This command creates a new base docs repo to be managed by AsciiBinderGabrielRH
+
+  Scenario: A user tries to create a repo in an existing directory
+    Given an existing repo directory
+    When the user runs `asciibinder create` on that repo directory
+    Then the program exits with a warning
+
+  Scenario: A user tries to create a repo in a nonexistent directory
+    Given a nonexistent repo directory
+    When the user runs `asciibinder create` on that repo directory
+    Then the program generates a new base docs repo

data/features/repo_package.feature

@@ -0,0 +1,15 @@
+Feature: asciibinder package
+
+  Causes the utility to run a `build` operation and then marshall
+  together all of the distro / branch combinations that will be
+  published into "sites". Each site has a distinct home page.
+
+  Scenario: A user wants to package all of the sites contained in their docs repo
+    Given a valid AsciiBinderGabrielRH docs repo with multiple distros
+    When the user runs `asciibinder package` on that repo directory
+    Then the program generates a site directory for each site in the distro map
+
+  Scenario: A user wants to package one of the sites contained in their docs repo
+    Given a valid AsciiBinderGabrielRH docs repo with multiple distros
+    When the user runs `asciibinder package --site=test` on that repo directory
+    Then the program generates a site directory for only the `test` site in the distro map