diff --git a/Guardfile b/Guardfile index c6bfff0a742e..69b613a87ff0 100644 --- a/Guardfile +++ b/Guardfile @@ -1,20 +1,14 @@ -require 'asciidoctor' -require 'erb' -require 'haml' -require 'tilt' - guard 'shell' do watch(/^.*\.adoc$/) { |m| if not m[0].start_with?('_preview') src_group_path = m[0].split('/')[0] filename = m[0].split('/')[-1][0..-6] - tgt_file_path = "_preview/#{src_group_path}" - Asciidoctor.render_file m[0], :in_place => true, :safe => :unsafe, :template_dir => '_template', :attributes => ['source-highlighter=coderay','coderay-css=style',"stylesdir=_preview/stylesheets","imagesdir=#{src_group_path}/images",'stylesheet=origin.css','linkcss!','icons=font','idprefix=','idseparator=-','sectanchors'] - system('mv', "#{src_group_path}/#{filename}.html", "#{tgt_file_path}/") + system("bundle exec rake refresh_page['#{src_group_path}:#{filename}']") end } end guard 'livereload' do - watch(%r{^_preview\.(css|js|html)$}) + watch(%r{^_preview/.+\.(css|js|html)$}) + watch(%r{^_preview/.+\/.+\/.+\.(css|js|html)$}) end diff --git a/Rakefile b/Rakefile index 08ac44a47e5a..0a075c143583 100644 --- a/Rakefile +++ b/Rakefile @@ -1,445 +1,17 @@ -require 'asciidoctor' -require 'git' -require 'logger' -require 'pandoc-ruby' -require 'pathname' +require "#{File.join(Dir.pwd,'_builder_lib/docsitebuilder/helpers')}" require 'rake' -require 'yaml' -BUILD_FILENAME = '_build_cfg.yml' -BUILDER_DIRNAME = '_build_system' -PREVIEW_DIRNAME = '_preview' -PACKAGE_DIRNAME = '_package' -BLANK_STRING_RE = Regexp.new('^\s*$') -PRODUCT_AUTHOR = "OpenShift Documentation Project " -ANALYTICS_SHIM = '' - -def source_dir - @source_dir ||= File.expand_path(Dir.pwd) -end - -def template_dir - @template_dir ||= File.join(source_dir,'_templates') -end - -def preview_dir - @preview_dir ||= begin - preview_dir = File.join(source_dir,PREVIEW_DIRNAME) - if not File.exists?(preview_dir) - Dir.mkdir(preview_dir) - end - preview_dir - end -end - -def package_dir - @package_dir ||= begin - package_dir = File.join(source_dir,PACKAGE_DIRNAME) - if not File.exists?(package_dir) - Dir.mkdir(package_dir) - end - package_dir - end -end - -def build_date - Time.now.utc -end - -def git - @git ||= Git.open(source_dir) -end - -def git_checkout branch_name - target_branch = git.branches.local.select{ |b| b.name == branch_name }[0] - if not target_branch.current - target_branch.checkout - end -end - -# Returns the local git branches; current branch is always first -def local_branches - @local_branches ||= begin - branches = [] - branches << git.branches.local.select{ |b| b.current }[0].name - branches << git.branches.local.select{ |b| not b.current }.map{ |b| b.name } - branches.flatten - end -end - -def build_config_file - @build_config_file ||= File.join(source_dir,BUILD_FILENAME) -end - -def build_config - @build_config ||= validate_config(YAML.load_stream(open(build_config_file))) -end - -def distro_map - @distro_map ||= begin - { 'openshift-origin' => { - :name => 'OpenShift Origin', - :branches => { - 'master' => { - :name => 'Nightly Build', - :dir => 'latest', - }, - 'origin-4' => { - :name => 'Version 4', - :dir => 'stable', - }, - }, - }, - 'openshift-online' => { - :name => 'OpenShift Online', - :branches => { - 'online' => { - :name => 'Latest Release', - :dir => 'online', - }, - }, - }, - 'openshift-enterprise' => { - :name => 'OpenShift Enterprise', - :branches => { - 'enterprise-2.2' => { - :name => 'Version 2.2', - :dir => 'enterprise/v2.2', - }, - }, - } - } - end -end - -def distro_branches(use_distro='') - @distro_branches ||= begin - use_distro_list = use_distro == '' ? distro_map.keys : [use_distro] - distro_map.select{ |dkey,dval| use_distro_list.include?(dkey) }.map{ |distro,dconfig| dconfig[:branches].keys }.flatten - end -end - -def page(args) - page_css = '' - args[:css].each do |sheet| - sheet_href = args[:css_path] + sheet - page_css << "\n" - end - page_head = < - - -#{args[:distro]} #{args[:version]} | #{args[:group_title]} | #{args[:topic_title]} -#{page_css} - - - - -
-

OpenShift Documentation #{args[:distro]} #{args[:version]}

-
-
-
-
- - - - - -
-

 

-
-EOF - - page_nav = ['
'] - groupidx = 0 - args[:navigation].each do |topic_group| - current_group = topic_group[:id] == args[:group_id] - page_nav << '
' - page_nav << '
' - page_nav << '

' - page_nav << " #{topic_group[:name]}" - page_nav << '

' - page_nav << '
' - page_nav << "
    " - topic_group[:topics].each do |topic| - current_topic = topic[:id] == args[:topic_id] - page_nav << "
  • #{topic[:name]}
    • " - end - page_nav << '
' - page_nav << '
' - groupidx = groupidx + 1 - end - page_nav << '
' - - page_body = < -
-
-

#{args[:group_title]}: #{args[:topic_title]}

-
- #{args[:content]} -
-
-
-#{ANALYTICS_SHIM} - - -EOF - - page_txt = '' - page_txt << page_head - page_txt << "\n" - page_txt << page_nav.join("\n") - page_txt << "\n" - page_txt << page_body - page_txt -end - -def parse_distros distros_string, for_validation=false - values = distros_string.split(',').map{ |v| v.strip } - return values if for_validation - return distro_map.keys if values.include?('all') - return values.uniq -end - -def validate_distros distros_string - return false if not distros_string.is_a?(String) - values = parse_distros(distros_string, true) - values.each do |v| - return false if not v == 'all' or not distro_map.keys.include?(v) - end - return true -end - -def validate_config config_data - # Validate/normalize the config file straight away - if not config_data.is_a?(Array) - raise "The configutaration in #{build_config_file} is malformed; the build system is expecting an array of topic groups." - end - config_data.each do |topic_group| - # Check for presence of topic group keys - ['Name','Dir','Topics'].each do |group_key| - if not topic_group.has_key?(group_key) - raise "One of the topic groups in #{build_config_file} is missing the '#{group_key}' key." - end - end - # Check for right format of topic group values - ['Name','Dir'].each do |group_key| - if not topic_group[group_key].is_a?(String) - raise "One of the topic groups in #{build_config_file} is not using a string for the #{group_key} setting; current value is #{topic_group[group_key].inspect}" - end - if topic_group[group_key].empty? or topic_group[group_key].match BLANK_STRING_RE - raise "One of the topic groups in #{build_config_file} is using a blank value for the #{group_key} setting." - end - end - if not File.exists?(File.join(source_dir,topic_group['Dir'])) - raise "In #{build_config_file}, the directory #{topic_group['Dir']} for topic group #{topic_group['Name']} does not exist under #{source_dir}" - end - # Validate the Distros setting - if topic_group.has_key?('Distros') - if not validate_distros(topic_group['Distros']) - key_list = distro_map.keys.map{ |k| "'#{k.to_s}'" }.sort.join(', ') - raise "In #{build_config_file}, the Distros value #{topic_group['Distros'].inspect} for topic group #{topic_group['Name']} is not valid. Legal values are 'all', #{key_list}, or a comma-separated list of legal values." - end - topic_group['Distros'] = parse_distros(topic_group['Distros']) - else - topic_group['Distros'] = parse_distros('all') - end - if not topic_group['Topics'].is_a?(Array) - raise "The #{topic_group['Name']} topic group in #{build_config_file} is malformed; the build system is expecting an array of 'Topic' definitions." - end - # Generate an ID for this topic group - topic_group['ID'] = camelize topic_group['Name'] - # Now buzz through the topics - topic_group['Topics'].each do |topic| - ['Name','File'].each do |topic_key| - if not topic[topic_key].is_a?(String) - raise "In #{build_config_file}, topic group #{topic_group['Name']}, one of the topics is not using a string for the '#{topic_key}' setting; current value is #{topic[topic_key].inspect}" - end - if topic[topic_key].empty? or topic[topic_key].match BLANK_STRING_RE - raise "In #{build_config_file}, topic group #{topic_group['Name']}, one of the topics is using a blank value for the '#{topic_key}' setting" - end - end - # Normalize the filenames - if topic['File'].end_with?('.adoc') - topic['File'] = topic['File'][0..-6] - end - if not File.exists?(File.join(source_dir,topic_group['Dir'],"#{topic['File']}.adoc")) - raise "In #{build_config_file}, could not find file #{topic['File']} under directory #{topic_group['Dir']} for topic #{topic['Name']} in topic group #{topic_group['Name']}." - end - if topic.has_key?('Distros') - if not validate_distros(topic['Distros']) - key_list = distro_map.keys.map{ |k| "'#{k.to_s}'" }.sort.join(', ') - raise "In #{build_config_file}, the Distros value #{topic_group['Distros'].inspect} for topic item #{topic['Name']} in topic group #{topic_group['Name']} is not valid. Legal values are 'all', #{key_list}, or a comma-separated list of legal values." - end - topic['Distros'] = parse_distros(topic['Distros']) - else - topic['Distros'] = parse_distros('all') - end - # Generate an ID for this topic - topic['ID'] = "#{topic_group['ID']}::#{camelize(topic['Name'])}" - end - end - config_data -end - -def camelize text - text.split(' ').map{ |t| t.capitalize }.join -end - -def nav_tree distro - @nav_tree ||= begin - navigation = [] - build_config.each do |topic_group| - next if not topic_group['Distros'].include?(distro) - next if topic_group['Topics'].select{ |t| t['Distros'].include?(distro) }.length == 0 - topic_list = [] - topic_group['Topics'].each do |topic| - next if not topic['Distros'].include?(distro) - topic_list << { - :path => "../#{topic_group['Dir']}/#{topic['File']}.html", - :name => topic['Name'], - :id => topic['ID'], - } - end - navigation << { :name => topic_group['Name'], :id => topic_group['ID'], :topics => topic_list } - end - navigation - end -end - -def asciidoctor_page_attrs(more_attrs=[]) - [ - 'source-highlighter=coderay', - 'coderay-css=style', - 'linkcss!', - 'icons=font', - 'idprefix=', - 'idseparator=-', - 'sectanchors', - ].concat(more_attrs) -end +include DocSiteBuilder::Helpers task :build, :build_distro do |task,args| # Figure out which distros we are building. # A blank value here == all distros build_distro = args[:build_distro] || '' + generate_docs(build_distro) +end - if not build_distro == '' - if not distro_map.has_key?(build_distro) - puts "Unrecognized distro '#{build_distro}'; cancelling build." - exit - else - puts "Building the #{distro_map[build_distro][:name]} distribution(s)." - end - else - puts "Building all available distributions." - end - - # First, notify the user of missing local branches - missing_branches = [] - distro_branches(build_distro).sort.each do |dbranch| - next if local_branches.include?(dbranch) - missing_branches << dbranch - end - if missing_branches.length > 0 - puts "\nNOTE: The following branches do not exist in your local git repo:" - missing_branches.each do |mbranch| - puts "- #{mbranch}" - end - puts "The build will proceed but these branches will not be generated." - end - distro_map.each do |distro,distro_config| - if not build_distro == '' and not build_distro == distro - next - end - puts "\nBuilding #{distro_config[:name]}" - distro_config[:branches].each do |branch,branch_config| - if missing_branches.include?(branch) - puts "- skipping #{branch}" - next - end - puts "- building #{branch}" - - # Put us on the correct branch - git_checkout(branch) - - # Create the target dir - branch_path = File.join(preview_dir,branch_config[:dir]) - system("mkdir -p #{branch_path}/stylesheets") - - # Copy stylesheets into preview area - system("cp -r _stylesheets/*css #{branch_path}/stylesheets") - - # Build the landing page - navigation = nav_tree(distro) - - # Build the topic files - build_config.each do |topic_group| - next if not topic_group['Distros'].include?(distro) - next if topic_group['Topics'].select{ |t| t['Distros'].include?(distro) }.length == 0 - src_group_path = File.join(source_dir,topic_group['Dir']) - tgt_group_path = File.join(branch_path,topic_group['Dir']) - if not File.exists?(tgt_group_path) - Dir.mkdir(tgt_group_path) - end - topic_group['Topics'].each do |topic| - next if not topic['Distros'].include?(distro) - src_file_path = File.join(src_group_path,"#{topic['File']}.adoc") - tgt_file_path = File.join(tgt_group_path,"#{topic['File']}.html") - puts " - #{File.join(topic_group['Dir'],topic['File'])}" - topic_adoc = File.open(src_file_path,'r').read - page_attrs = asciidoctor_page_attrs([ - "imagesdir=#{src_group_path}/images", - distro, - "product-title=#{distro_config[:name]}", - "product-version=#{branch_config[:name]}", - "product-author=#{PRODUCT_AUTHOR}" - ]) - topic_html = Asciidoctor.render topic_adoc, :header_footer => false, :safe => :unsafe, :attributes => page_attrs - full_file_text = page({ - :distro => distro_config[:name], - :version => branch_config[:name], - :group_title => topic_group['Name'], - :topic_title => topic['Name'], - :content => topic_html, - :navigation => navigation, - :group_id => topic_group['ID'], - :topic_id => topic['ID'], - :css_path => "../../#{branch_config[:dir]}/stylesheets/", - :css => [ - 'bootstrap_default.min.css', - 'font-awesome.min.css', - 'foundation.css', - 'origin.css', - ], - :nav_expanded => (topic_group['Dir'] == 'welcome' and topic['File'].start_with?('index')), - }) - File.write(tgt_file_path,full_file_text) - end - end - end - - # Create a distro landing page - # WARNING: if building mutiple distros, this file will be overwritten by each distro - src_file_path = File.join(source_dir,'index.adoc') - topic_adoc = File.open(src_file_path,'r').read - page_attrs = asciidoctor_page_attrs([ - "imagesdir=#{File.join(source_dir,'_site_images')}", - distro, - "product-title=#{distro_config[:name]}", - "product-version=Updated #{build_date}", - "product-author=#{PRODUCT_AUTHOR}" - ]) - topic_html = Asciidoctor.render topic_adoc, :header_footer => true, :safe => :unsafe, :attributes => page_attrs - File.write(File.join(preview_dir,'index.html'),topic_html) - - # Return to the original branch - git_checkout(local_branches[0]) - end - - puts "\nAll builds completed." +task :refresh_page, :single_page do |task,args| + generate_docs('',args[:single_page]) end task :clean do diff --git a/_builder_lib/docsitebuilder/helpers.rb b/_builder_lib/docsitebuilder/helpers.rb new file mode 100644 index 000000000000..8a927c30e392 --- /dev/null +++ b/_builder_lib/docsitebuilder/helpers.rb @@ -0,0 +1,470 @@ +require 'asciidoctor' +require 'git' +require 'logger' +require 'pandoc-ruby' +require 'pathname' +require 'yaml' + +module DocSiteBuilder + module Helpers + + BUILD_FILENAME = '_build_cfg.yml' + BUILDER_DIRNAME = '_build_system' + PREVIEW_DIRNAME = '_preview' + PACKAGE_DIRNAME = '_package' + BLANK_STRING_RE = Regexp.new('^\s*$') + PRODUCT_AUTHOR = "OpenShift Documentation Project " + ANALYTICS_SHIM = '' + + def source_dir + @source_dir ||= File.expand_path '../../../', __FILE__ + end + + def template_dir + @template_dir ||= File.join(source_dir,'_templates') + end + + def preview_dir + @preview_dir ||= begin + preview_dir = File.join(source_dir,PREVIEW_DIRNAME) + if not File.exists?(preview_dir) + Dir.mkdir(preview_dir) + end + preview_dir + end + end + + def package_dir + @package_dir ||= begin + package_dir = File.join(source_dir,PACKAGE_DIRNAME) + if not File.exists?(package_dir) + Dir.mkdir(package_dir) + end + package_dir + end + end + + def build_date + Time.now.utc + end + + def git + @git ||= Git.open(source_dir) + end + + def git_checkout branch_name + target_branch = git.branches.local.select{ |b| b.name == branch_name }[0] + if not target_branch.current + target_branch.checkout + end + end + + # Returns the local git branches; current branch is always first + def local_branches + @local_branches ||= begin + branches = [] + branches << git.branches.local.select{ |b| b.current }[0].name + branches << git.branches.local.select{ |b| not b.current }.map{ |b| b.name } + branches.flatten + end + end + + def working_branch + local_branches[0] + end + + def build_config_file + @build_config_file ||= File.join(source_dir,BUILD_FILENAME) + end + + # Protip: Don't cache this! It needs to be reread every time we change branches. + def build_config + validate_config(YAML.load_stream(open(build_config_file))) + end + + def distro_map + @distro_map ||= begin + { 'openshift-origin' => { + :name => 'OpenShift Origin', + :branches => { + 'master' => { + :name => 'Nightly Build', + :dir => 'latest', + }, + 'origin-4' => { + :name => 'Version 4', + :dir => 'stable', + }, + }, + }, + 'openshift-online' => { + :name => 'OpenShift Online', + :branches => { + 'online' => { + :name => 'Latest Release', + :dir => 'online', + }, + }, + }, + 'openshift-enterprise' => { + :name => 'OpenShift Enterprise', + :branches => { + 'enterprise-2.2' => { + :name => 'Version 2.2', + :dir => 'enterprise/v2.2', + }, + }, + } + } + end + end + + def distro_branches(use_distro='') + @distro_branches ||= begin + use_distro_list = use_distro == '' ? distro_map.keys : [use_distro] + distro_map.select{ |dkey,dval| use_distro_list.include?(dkey) }.map{ |distro,dconfig| dconfig[:branches].keys }.flatten + end + end + + def page(args) + page_css = '' + args[:css].each do |sheet| + sheet_href = args[:css_path] + sheet + page_css << "\n" + end + page_head = < + + +#{args[:distro]} #{args[:version]} | #{args[:group_title]} | #{args[:topic_title]} +#{page_css} + + + + +
+

OpenShift Documentation #{args[:distro]} #{args[:version]}

+
+
+
+
+ + + + + +
+

 

+
+EOF + + page_nav = ['
'] + groupidx = 0 + args[:navigation].each do |topic_group| + current_group = topic_group[:id] == args[:group_id] + page_nav << '
' + page_nav << '
' + page_nav << '

' + page_nav << " #{topic_group[:name]}" + page_nav << '

' + page_nav << '
' + page_nav << "
    " + topic_group[:topics].each do |topic| + current_topic = topic[:id] == args[:topic_id] + page_nav << "
  • #{topic[:name]}
    • " + end + page_nav << '
' + page_nav << '
' + groupidx = groupidx + 1 + end + page_nav << '
' + + page_body = < +
+
+

#{args[:group_title]}: #{args[:topic_title]}

+
+ #{args[:content]} +
+
+
+#{ANALYTICS_SHIM} + + +EOF + + page_txt = '' + page_txt << page_head + page_txt << "\n" + page_txt << page_nav.join("\n") + page_txt << "\n" + page_txt << page_body + page_txt + end + + def parse_distros distros_string, for_validation=false + values = distros_string.split(',').map{ |v| v.strip } + return values if for_validation + return distro_map.keys if values.include?('all') + return values.uniq + end + + def validate_distros distros_string + return false if not distros_string.is_a?(String) + values = parse_distros(distros_string, true) + values.each do |v| + return false if not v == 'all' or not distro_map.keys.include?(v) + end + return true + end + + def validate_config config_data + # Validate/normalize the config file straight away + if not config_data.is_a?(Array) + raise "The configutaration in #{build_config_file} is malformed; the build system is expecting an array of topic groups." + end + config_data.each do |topic_group| + # Check for presence of topic group keys + ['Name','Dir','Topics'].each do |group_key| + if not topic_group.has_key?(group_key) + raise "One of the topic groups in #{build_config_file} is missing the '#{group_key}' key." + end + end + # Check for right format of topic group values + ['Name','Dir'].each do |group_key| + if not topic_group[group_key].is_a?(String) + raise "One of the topic groups in #{build_config_file} is not using a string for the #{group_key} setting; current value is #{topic_group[group_key].inspect}" + end + if topic_group[group_key].empty? or topic_group[group_key].match BLANK_STRING_RE + raise "One of the topic groups in #{build_config_file} is using a blank value for the #{group_key} setting." + end + end + if not File.exists?(File.join(source_dir,topic_group['Dir'])) + raise "In #{build_config_file}, the directory #{topic_group['Dir']} for topic group #{topic_group['Name']} does not exist under #{source_dir}" + end + # Validate the Distros setting + if topic_group.has_key?('Distros') + if not validate_distros(topic_group['Distros']) + key_list = distro_map.keys.map{ |k| "'#{k.to_s}'" }.sort.join(', ') + raise "In #{build_config_file}, the Distros value #{topic_group['Distros'].inspect} for topic group #{topic_group['Name']} is not valid. Legal values are 'all', #{key_list}, or a comma-separated list of legal values." + end + topic_group['Distros'] = parse_distros(topic_group['Distros']) + else + topic_group['Distros'] = parse_distros('all') + end + if not topic_group['Topics'].is_a?(Array) + raise "The #{topic_group['Name']} topic group in #{build_config_file} is malformed; the build system is expecting an array of 'Topic' definitions." + end + # Generate an ID for this topic group + topic_group['ID'] = camelize topic_group['Name'] + # Now buzz through the topics + topic_group['Topics'].each do |topic| + ['Name','File'].each do |topic_key| + if not topic[topic_key].is_a?(String) + raise "In #{build_config_file}, topic group #{topic_group['Name']}, one of the topics is not using a string for the '#{topic_key}' setting; current value is #{topic[topic_key].inspect}" + end + if topic[topic_key].empty? or topic[topic_key].match BLANK_STRING_RE + raise "In #{build_config_file}, topic group #{topic_group['Name']}, one of the topics is using a blank value for the '#{topic_key}' setting" + end + end + # Normalize the filenames + if topic['File'].end_with?('.adoc') + topic['File'] = topic['File'][0..-6] + end + if not File.exists?(File.join(source_dir,topic_group['Dir'],"#{topic['File']}.adoc")) + raise "In #{build_config_file}, could not find file #{topic['File']} under directory #{topic_group['Dir']} for topic #{topic['Name']} in topic group #{topic_group['Name']}." + end + if topic.has_key?('Distros') + if not validate_distros(topic['Distros']) + key_list = distro_map.keys.map{ |k| "'#{k.to_s}'" }.sort.join(', ') + raise "In #{build_config_file}, the Distros value #{topic_group['Distros'].inspect} for topic item #{topic['Name']} in topic group #{topic_group['Name']} is not valid. Legal values are 'all', #{key_list}, or a comma-separated list of legal values." + end + topic['Distros'] = parse_distros(topic['Distros']) + else + topic['Distros'] = parse_distros('all') + end + # Generate an ID for this topic + topic['ID'] = "#{topic_group['ID']}::#{camelize(topic['Name'])}" + end + end + config_data + end + + def camelize text + text.split(' ').map{ |t| t.capitalize }.join + end + + def nav_tree distro, distro_build_config + navigation = [] + distro_build_config.each do |topic_group| + next if not topic_group['Distros'].include?(distro) + next if topic_group['Topics'].select{ |t| t['Distros'].include?(distro) }.length == 0 + topic_list = [] + topic_group['Topics'].each do |topic| + next if not topic['Distros'].include?(distro) + topic_list << { + :path => "../#{topic_group['Dir']}/#{topic['File']}.html", + :name => topic['Name'], + :id => topic['ID'], + } + end + navigation << { :name => topic_group['Name'], :id => topic_group['ID'], :topics => topic_list } + end + navigation + end + + def asciidoctor_page_attrs(more_attrs=[]) + [ + 'source-highlighter=coderay', + 'coderay-css=style', + 'linkcss!', + 'icons=font', + 'idprefix=', + 'idseparator=-', + 'sectanchors', + ].concat(more_attrs) + end + + def generate_docs(build_distro,single_page=nil) + single_page_dir = nil + single_page_file = nil + if not single_page.nil? + single_page_dir = single_page.split(':')[0] + single_page_file = single_page.split(':')[1] + puts "Rebuilding '#{single_page}' on branch '#{working_branch}'." + end + if not build_distro == '' + if not distro_map.has_key?(build_distro) + puts "Unrecognized distro '#{build_distro}'; cancelling build." + exit + else + puts "Building the #{distro_map[build_distro][:name]} distribution(s)." + end + elsif single_page.nil? + puts "Building all available distributions." + end + + # First, notify the user of missing local branches + missing_branches = [] + distro_branches(build_distro).sort.each do |dbranch| + next if local_branches.include?(dbranch) + missing_branches << dbranch + end + if missing_branches.length > 0 and single_page.nil? + puts "\nNOTE: The following branches do not exist in your local git repo:" + missing_branches.each do |mbranch| + puts "- #{mbranch}" + end + puts "The build will proceed but these branches will not be generated." + end + + distro_map.each do |distro,distro_config| + if not build_distro == '' and not build_distro == distro + next + end + first_branch = single_page.nil? + distro_config[:branches].each do |branch,branch_config| + if not single_page.nil? and not working_branch == branch + next + end + if first_branch + puts "\nBuilding #{distro_config[:name]}" + first_branch = false + end + if missing_branches.include?(branch) + puts "- skipping #{branch}" + next + end + if single_page.nil? + puts "- building #{branch}" + git_checkout(branch) + end + + # Create the target dir + branch_path = File.join(preview_dir,branch_config[:dir]) + system("mkdir -p #{branch_path}/stylesheets") + + # Copy stylesheets into preview area + system("cp -r _stylesheets/*css #{branch_path}/stylesheets") + + # Read the _build_config.yml for this distro + distro_build_config = build_config + + # Build the landing page + navigation = nav_tree(distro,distro_build_config) + + # Build the topic files + distro_build_config.each do |topic_group| + next if not topic_group['Distros'].include?(distro) + next if topic_group['Topics'].select{ |t| t['Distros'].include?(distro) }.length == 0 + next if not single_page.nil? and not single_page_dir == topic_group['Dir'] + src_group_path = File.join(source_dir,topic_group['Dir']) + tgt_group_path = File.join(branch_path,topic_group['Dir']) + if not File.exists?(tgt_group_path) + Dir.mkdir(tgt_group_path) + end + topic_group['Topics'].each do |topic| + next if not topic['Distros'].include?(distro) + next if not single_page.nil? and not topic['File'] == single_page_file + src_file_path = File.join(src_group_path,"#{topic['File']}.adoc") + tgt_file_path = File.join(tgt_group_path,"#{topic['File']}.html") + if single_page.nil? + puts " - #{File.join(topic_group['Dir'],topic['File'])}" + end + topic_adoc = File.open(src_file_path,'r').read + page_attrs = asciidoctor_page_attrs([ + "imagesdir=#{src_group_path}/images", + distro, + "product-title=#{distro_config[:name]}", + "product-version=#{branch_config[:name]}", + "product-author=#{PRODUCT_AUTHOR}" + ]) + topic_html = Asciidoctor.render topic_adoc, :header_footer => false, :safe => :unsafe, :attributes => page_attrs + full_file_text = page({ + :distro => distro_config[:name], + :version => branch_config[:name], + :group_title => topic_group['Name'], + :topic_title => topic['Name'], + :content => topic_html, + :navigation => navigation, + :group_id => topic_group['ID'], + :topic_id => topic['ID'], + :css_path => "../../#{branch_config[:dir]}/stylesheets/", + :css => [ + 'bootstrap_default.min.css', + 'font-awesome.min.css', + 'foundation.css', + 'origin.css', + ], + }) + File.write(tgt_file_path,full_file_text) + if not single_page.nil? + return + end + end + end + end + + # Create a distro landing page + # WARNING: if building mutiple distros, this file will be overwritten by each distro + src_file_path = File.join(source_dir,'index.adoc') + topic_adoc = File.open(src_file_path,'r').read + page_attrs = asciidoctor_page_attrs([ + "imagesdir=#{File.join(source_dir,'_site_images')}", + distro, + "product-title=#{distro_config[:name]}", + "product-version=Updated #{build_date}", + "product-author=#{PRODUCT_AUTHOR}" + ]) + topic_html = Asciidoctor.render topic_adoc, :header_footer => true, :safe => :unsafe, :attributes => page_attrs + File.write(File.join(preview_dir,'index.html'),topic_html) + + # Return to the original branch + git_checkout(local_branches[0]) + end + + puts "\nAll builds completed." + end + end +end