origen 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67638f71155b698c46c36ac11275cbd932f59f4c
-  data.tar.gz: 71f951d39c6a92b7f9ffc4a60b8613f164cdab61
+  metadata.gz: 2444b500452b441ffe3b828caf07864c4bac244c
+  data.tar.gz: bf221ec3d4731ac3e36a5c2ea25ec3b65cc4680c
 SHA512:
-  metadata.gz: cc180e1083595da71e9d7ffe40a34fe084fc950f0cd9affd03da76f62695bc398d97dc7b7112386c56b66f903fd8072c4b06a9507c4205fb1a541e91ad748c7a
-  data.tar.gz: 4cdac149a1a653a8aede5ea906f2fdbfce0c625c90dcf6cca5dad24d86fb498010eedac1e6513127f32d614e53d3461d3108b914a1e0596e2ac50b60bc02d678
+  metadata.gz: c299c349c1623868cccc9e93a0cdbab6e9b20b19471c83db65a89c273a80d2fe455e48b7b8d09395238fc4f35bc83810343c4d8c2cc7326951b1f5a405424f33
+  data.tar.gz: cfe2bae4e3193971e82f470e0a542ade063aa941bd08d32980884af5a0b3ae0bd9549641b01e35a1db5132f244a990c713bb7e1332c045b4be37968a09ccd723

data/config/application.rb

@@ -29,8 +29,7 @@ class OrigenCoreApplication < Origen::Application
 
   #config.lsf.project = "origen core"
   
-  config.web_directory = "/proj/.web_origen/html/origen"
-
+  config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/origen"
   config.web_domain = "http://origen-sdk.org/origen"
   
   config.pattern_prefix = "nvm"
@@ -112,13 +111,13 @@ class OrigenCoreApplication < Origen::Application
   end
 
   def before_deploy_site
-    Dir.chdir Origen.root do
-      system "origen specs -c"
-      system "origen examples -c"
-      dir = "#{Origen.root}/web/output/coverage"       
-      FileUtils.remove_dir(dir, true) if File.exists?(dir) 
-      system "mv #{Origen.root}/coverage #{dir}"
-    end
+    #Dir.chdir Origen.root do
+    #  system "origen specs -c"
+    #  system "origen examples -c"
+    #  dir = "#{Origen.root}/web/output/coverage"       
+    #  FileUtils.remove_dir(dir, true) if File.exists?(dir) 
+    #  system "mv #{Origen.root}/coverage #{dir}"
+    #end
   end
 
   def after_release_email(tag, note, type, selector, options)

data/config/version.rb

@@ -1,7 +1,7 @@
 module Origen
   MAJOR = 0
   MINOR = 0
-  BUGFIX = 4
+  BUGFIX = 5
   DEV = nil
 
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/helpers/url.rb

@@ -23,6 +23,9 @@ module Origen
           
           if Origen.development?
             "#{p}"   # dev mode used for local website generation
+          # For Git deploy don't maintain versions
+          elsif Origen.app.deployer.deploy_to_git?
+            "#{root_path}#{p}"
           else          
             "#{root_path}/#{_version}#{p}"
           end
@@ -54,8 +57,8 @@ module Origen
           end
         end
 
-        # Returns any path attached to the domain, for example will return "/tfs"
-        # for "http://origen.freescale.net/tfs"
+        # Returns any path attached to the domain, for example will return "/jtag"
+        # for "http://origen-sdk.org/jtag"
         def root_path # :nodoc:
           if domain =~ /\/\/[^\/]*(\/.*)/  # http://rubular.com/r/UY06Z6DXUS
             $1

data/lib/origen/application/deployer.rb

@@ -1,75 +1,90 @@
 module Origen
   class Application
-    # This class currently serves two APIs and is a bit of a mess.
-    # The first API is the old style deploy which is deprecated, in this approach the
-    # entire application was built and manged remotely with pages compiled in the remote
-    # application.
+    # This class manages deploying an application's website.
     #
-    # The new appraoch is that the web pages are compiled in the local application and
-    # then deploy consists of simply copying them to the remote location.
+    # The web pages are compiled in the local application workspace and
+    # deploy consists of copying them to the remote location.
+    #
+    # Two directories are maintained in the remote location, one containing the live
+    # website and another where the new site is copied to during a deploy.
+    # A symlink is used to indicate which one of the two directories is currently being
+    # served.
+    #
+    # Upon a successful copy the symlink is switched over, thereby providing zero-downtime
+    # deploys and guaranteeing that the old site will stay up if an error is encountered
+    # during a deploy.
+    #
+    # An alternative method of deploying is also supported by pushing to a Git repository.
     class Deployer
       require 'fileutils'
 
-      attr_writer :version, :directory, :origen_directory, :rdoc_command, :test
-
-      # Deploys this release to origen.freescale.net/tfs
-      # This needs to be made generic so that projects can use it to, right now this
-      # code exists both here and in the TFS project
-      def deploy(options = {})
-        options = {
-          test:    false,         # Do a test run deploy in the local workspace
-          archive: false
-        }.merge(options)
-        @directory = options[:directory]
-        @app_sub_directory = options[:app_sub_directory]
-        @test = options[:test]
-        @version = options[:version]
-        @rdoc_command = options[:rdoc_command]
-        @successful = false
-
-        puts '***********************************************************************'
-        puts "'deploy' is deprecated, please transition to 'origen web compile' instead"
-        puts '***********************************************************************'
+      attr_writer :directory, :test
 
-        begin
-          puts ''
-          puts 'Deploying...'
-          puts ''
-          populate(offline_release_dir) unless test_run?
-          generate_web_pages
-          generate_rdoc_pages if @rdoc_command
-          # If web pages were generated compile them through nanoc, this is not done
-          # as part of generate web pages to allow the application to add additional web
-          # pages during the rdoc command
-          if @nanoc_dir
-            Dir.chdir @nanoc_dir do
-              system 'nanoc'
-            end
+      # Prepare for deploying, this will raise an error if the current user is found to
+      # have insufficient permissions to deploy to the target directory
+      def prepare!(options = {})
+        if deploy_to_git?
+          require 'highline/import'
+          @commit_message = options[:message] || ask('Enter a deployment commit message:  ') do |q|
+            q.validate = /\w/
+            q.responses[:not_valid] = "Can't be blank"
+          end
+          Origen.log.info "Fetching the website's Git respository..."
+          begin
+            git_repo
+            fail unless git_repo.can_checkin?
+          rescue
+            puts "Sorry, but you don't have permission to write to #{Origen.config.web_directory}!"
+            exit 1
           end
-          unless test_run?
-            create_symlinks
-            make_archive if options[:archive]
+        else
+          begin
+            require_remote_directories
+            test_file = "#{Origen.config.web_directory}/_test_file.txt"
+            FileUtils.rm_f(test_file) if File.exist?(test_file)
+            FileUtils.touch(test_file)
+            FileUtils.rm_f(test_file)
+          rescue
+            puts "Sorry, but you don't have permission to write to #{Origen.config.web_directory}!"
+            exit 1
           end
-          @successful = true
-          true
-        rescue Exception => e
-          puts e.message
-          puts e.backtrace
-          deploy_unsuccessful(@directory)
-          @successful = false
-          false
         end
       end
 
-      # Reports whether the last deploy was successful or not
-      def successful?
-        @successful
+      def git_sub_dir
+        if Origen.config.web_directory =~ /\.git\/(.*)$/
+          Regexp.last_match(1)
+        end
+      end
+
+      # Returns a RevisionControl::Git object that points to a local copy of the website repo
+      # which is will build and checkout as required
+      def git_repo
+        @git_repo ||= begin
+          local = Pathname.new("#{Origen.app.workspace_manager.imports_directory}/git/#{Origen.config.web_directory.gsub('/', '-').symbolize}")
+          if git_sub_dir
+            remote = Origen.config.web_directory.sub("\/#{git_sub_dir}", '')
+          else
+            remote = Origen.config.web_directory
+          end
+          git = RevisionControl::Git.new(local: local, remote: remote)
+          if git.initialized?
+            git.checkout(force: true)
+          else
+            git.build(force: true)
+          end
+          git
+        end
       end
 
       def test_run?
         @test
       end
 
+      def deploy_to_git?
+        !!(Origen.config.web_directory =~ /\.git\/?#{git_sub_dir}$/)
+      end
+
       def require_remote_directories
         %w(remote1 remote2).each do |dir|
           dir = "#{Origen.config.web_directory}/#{dir}"
@@ -111,22 +126,33 @@ module Origen
       # directory to the remote server.
       def deploy_site
         Origen.app.listeners_for(:before_deploy_site).each(&:before_deploy_site)
-        # Empty the contents of the remote dir
-        if File.exist?(offline_remote_directory)
-          FileUtils.remove_dir(offline_remote_directory, true)
-          require_remote_directories
-        end
-        # Copy the new contents accross
-        `chmod g+w -R #{Origen.root}/web/output`      # Ensure group writable
-        FileUtils.cp_r "#{Origen.root}/web/output/.", offline_remote_directory
-        `chmod g+w -R #{offline_remote_directory}`  # Double ensure group writable
-        # Make live
-        create_symlink offline_remote_directory, latest_symlink
-        index = "#{Origen.config.web_directory}/index.html"
-        # This symlink allows the site homepage to be accessed from the web root
-        # directory rather than root directory/latest
-        unless File.exist?(index)
-          create_symlink "#{latest_symlink}/index.html", index
+        if deploy_to_git?
+          dir = git_repo.local.to_s
+          dir += "/#{git_sub_dir}" if git_sub_dir
+          # Delete everything so that we don't preserve old files
+          git_repo.delete_all(git_sub_dir)
+          FileUtils.mkdir_p(dir) unless File.exist?(dir)
+          `chmod a+w -R #{Origen.root}/web/output`      # Ensure world writable, required?
+          FileUtils.cp_r "#{Origen.root}/web/output/.", dir
+          git_repo.checkin git_sub_dir, unmanaged: true, comment: @commit_message
+        else
+          # Empty the contents of the remote dir
+          if File.exist?(offline_remote_directory)
+            FileUtils.remove_dir(offline_remote_directory, true)
+            require_remote_directories
+          end
+          # Copy the new contents across
+          `chmod g+w -R #{Origen.root}/web/output`      # Ensure group writable
+          FileUtils.cp_r "#{Origen.root}/web/output/.", offline_remote_directory
+          `chmod g+w -R #{offline_remote_directory}`  # Double ensure group writable
+          # Make live
+          create_symlink offline_remote_directory, latest_symlink
+          index = "#{Origen.config.web_directory}/index.html"
+          # This symlink allows the site homepage to be accessed from the web root
+          # directory rather than root directory/latest
+          unless File.exist?(index)
+            create_symlink "#{latest_symlink}/index.html", index
+          end
         end
       end
 
@@ -156,6 +182,18 @@ module Origen
           title = "#{Origen.config.name} #{Origen.app.version}"
         end
         system("yard doc --output-dir #{Origen.root}/web/output/api --title '#{title}'")
+        # Yard doesn't have an option to ignore github-style READMEs, so force it here to
+        # always present the API index on the API homepage for consistency
+        index = "#{Origen.root}/web/output/api/index.html"
+        _index = "#{Origen.root}/web/output/api/_index.html"
+        FileUtils.rm_f(index) if File.exist?(index)
+        # This removes a prominent link that we are left with to a README file that doesn't work
+        require 'nokogiri'
+        doc = Nokogiri::HTML(File.read(_index))
+        doc.xpath('//h2[contains(text(), "File Listing")]').remove
+        doc.css('#files').remove
+        File.open(_index, 'w') { |f| f.write(doc.to_html) }
+        FileUtils.cp(_index, index)
       end
 
       def deploy_archive(id)
@@ -169,48 +207,17 @@ module Origen
         end
       end
 
-      # Make an archive directory for the current release, this will create
-      # a new directory specifically for this release and copy over the web
-      # pages and api docs.
-      def make_archive
-        if version == 'latest'
-          puts 'Cannot archive latest, need a tag reference'
-        else
-          dir = archive_directory(force_clear: true)
-          FileUtils.cp_r Dir.glob("#{origen_directory}/web/output/*").sort, dir
-          api = "#{archive_directory}/api"
-          FileUtils.mkdir_p api unless File.exist?(api)
-          FileUtils.cp_r Dir.glob("#{origen_directory}/api/*").sort, api
-        end
-      end
-
-      def create_symlinks
-        {
-          "#{origen_directory}/web/output" => "#{root_directory}/latest",
-          "#{origen_directory}/api"        => "#{origen_directory}/web/output/api"
-
-        }.each do |from, to|
-          create_symlink(from, to)
-        end
-      end
-
       def create_symlink(from, to)
         `rm -f #{to}` if File.exist?(to)
         `ln -s #{from} #{to}` if File.exist?(from)
       end
 
-      def populate(dir)
-        # Populate to the new tag
-        system "dssc setvault #{Origen.config.vault} #{dir}"
-        system "dssc pop -rec -uni -force -ver #{version} #{dir}"
-      end
-
       def web_server_dir
-        "#{origen_directory}/web"
+        "#{Origen.root}/web"
       end
 
       def create_web_server_dir
-        if File.exist?("#{origen_directory}/templates/web")
+        if File.exist?("#{Origen.root}/templates/web")
           dir = web_server_dir
           FileUtils.rm_rf dir if File.exist?(dir)
           FileUtils.mkdir_p dir
@@ -220,10 +227,10 @@ module Origen
           Origen.app.runner.launch action: :compile,
                                    files:  "#{Origen.top}/templates/nanoc_dynamic",
                                    output: dir
-          unless Origen.root == origen_directory
+          unless Origen.root == Origen.top
             # Copy any application overrides if they exist
-            if File.exist?("#{origen_directory}/templates/nanoc")
-              FileUtils.cp_r Dir.glob("#{origen_directory}/templates/nanoc/*").sort, dir, remove_destination: true
+            if File.exist?("#{Origen.root}/templates/nanoc")
+              FileUtils.cp_r Dir.glob("#{Origen.root}/templates/nanoc/*").sort, dir, remove_destination: true
             end
           end
           # Remove the .SYNCs
@@ -231,137 +238,6 @@ module Origen
           @nanoc_dir = dir
         end
       end
-
-      # Compiles and creates the web documentation pages, combining the Origen Jekyll
-      # infrastructure and the application specific content
-      def generate_web_pages
-        if File.exist?("#{origen_directory}/templates/web")
-          create_web_server_dir
-          # Finally compile the application web pages
-          Origen.app.runner.generate(files:   "#{origen_directory}/templates/web",
-                                     compile: true,
-                                     output:  "#{@nanoc_dir}/content")
-        end
-      end
-
-      # Run the rdoc task
-      def generate_rdoc_pages
-        if File.exist?("#{origen_directory}/templates/api_doc")
-          Origen.app.runner.generate(files:   "#{origen_directory}/templates/api_doc",
-                                     compile: true,
-                                     output:  "#{origen_directory}/api_doc")
-        end
-        Dir.chdir origen_directory do
-          system "origen #{rdoc_command}"
-        end
-      end
-
-      def rdoc_command
-        @rdoc_command || 'rdoc'
-      end
-
-      # The top level directory that hosts all releases
-      def root_directory
-        return @root_directory if @root_directory
-        FileUtils.mkdir_p @directory unless File.exist?(@directory)
-        @root_directory = @directory
-      end
-
-      # The directory that contains the current release
-      def release_directory1
-        return @release_directory1 if @release_directory1
-        if test_run?
-          @release_directory1 = Origen.root
-        else
-          @release_directory1 = "#{root_directory}/release_1"
-          unless File.exist?(@release_directory1)
-            FileUtils.mkdir_p @release_directory1
-            populate(@release_directory1)
-          end
-        end
-        @release_directory1
-      end
-
-      def release_directory2
-        return @release_directory2 if @release_directory2
-        if test_run?
-          @release_directory2 = Origen.root
-        else
-          @release_directory2 = "#{root_directory}/release_2"
-          unless File.exist?(@release_directory2)
-            FileUtils.mkdir_p @release_directory2
-            populate(@release_directory2)
-          end
-        end
-        @release_directory2
-      end
-
-      def archive_directory(options = {})
-        ver = version
-        return Origen.root if test_run?
-        if options[:force_clear]
-          @archive_directory = "#{root_directory}/#{ver}"
-          FileUtils.rm_rf @archive_directory if File.exist?(@archive_directory)
-        else
-          return @archive_directory if @archive_directory
-          @archive_directory = "#{root_directory}/#{ver}"
-        end
-        FileUtils.mkdir_p @archive_directory unless File.exist?(@archive_directory)
-        @archive_directory
-      end
-
-      def offline_release_dir
-        link = "#{root_directory}/latest"
-        if File.exist?(link)
-          if File.readlink(link) =~ /release_1/
-            @offline_release_dir = release_directory2
-          else
-            @offline_release_dir = release_directory1
-          end
-        else
-          @offline_release_dir = release_directory1
-        end
-      end
-
-      # The directory that contains the Origen app for the current release
-      def origen_directory
-        return @origen_directory if @origen_directory
-        if test_run?
-          @origen_directory = Origen.root
-        else
-          @origen_directory = @app_sub_directory ? "#{offline_release_dir}/#{@app_sub_directory}" : offline_release_dir
-          FileUtils.mkdir_p @origen_directory unless File.exist?(@origen_directory)
-        end
-        @origen_directory
-      end
-
-      def version
-        @version
-      end
-
-      # Returns true if the user account belongs to the origen group
-      def user_belongs_to_origen?
-        if Origen.running_on_windows?
-          false
-        else
-          `"groups"`.gsub("\n", '').split(' ').include?('origen')
-        end
-      end
-
-      # Returns true if running on CDE
-      def running_on_cde?
-        if Origen.running_on_windows?
-          false
-        else
-          !!(`"domainname"` =~ /cde/i)
-        end
-      end
-
-      def deploy_unsuccessful(directory)
-        puts ''
-        puts "*** ERROR *** - Could not deploy to: #{directory}"
-        puts ''
-      end
     end
   end
 end

data/lib/origen/callbacks.rb

@@ -18,7 +18,7 @@ module Origen
   #
   # However within Origen core (and possibly some plugins) it is often the case that registered
   # listeners will be objects that are not re-instantiated upon target load and persist for
-  # the entire Origen thread. In this case use the CoreCallbacks module instead of the regular
+  # the entire Origen thread. In this case use the PersistentCallbacks module instead of the regular
   # Callbacks module to make these objects register as permanent listeners.
   module PersistentCallbacks
     extend ActiveSupport::Concern

data/lib/origen/commands/web.rb

@@ -132,7 +132,7 @@ The following options are available:
       Origen.app.load_target!
       if options[:remote]
         _require_web_directory
-        _deployer.require_remote_directories
+        _deployer.prepare!
         # If the whole site has been requested that start from a clean slate
         _build_web_dir if ARGV.empty?
       else

data/lib/origen/revision_control/git.rb

@@ -1,8 +1,8 @@
 module Origen
   module RevisionControl
     class Git < Base
-      def build
-        if Dir["#{local}/*"].empty?
+      def build(options = {})
+        if Dir["#{local}/*"].empty? || options[:force]
           FileUtils.rm_rf(local.to_s)
           # Not using the regular 'git' method here since the local dir doesn't exist to CD into
           system "git clone #{remote} #{local}"
@@ -74,7 +74,11 @@ module Origen
           checkout unless options[:initial]
         end
         cmd = 'add'
-        cmd += ' -u' unless options[:unmanaged]
+        if options[:unmanaged]
+          cmd += ' -A'
+        else
+          cmd += ' -u' unless options[:unmanaged]
+        end
         cmd += " #{paths.join(' ')}"
         git cmd, options
         if changes_pending_commit?
@@ -101,6 +105,15 @@ module Origen
         paths
       end
 
+      # Returns true if the current user can checkin to the given repo (means has permission
+      # to push in Git terms)
+      def can_checkin?
+        git('push --dry-run', verbose: false)
+        true
+      rescue
+        false
+      end
+
       def changes(dir = nil, options = {})
         paths, options = clean_path(dir, options)
         options = {
@@ -176,8 +189,25 @@ module Origen
         git('tag', verbose: false).include?(tag.to_s)
       end
 
+      def initialized?
+        File.exist?("#{local}/.git") &&
+          git('remote -v', verbose: false).any? { |r| r =~ /#{remote_without_protocol}/ } &&
+          !git('status', verbose: false).any? { |l| l == 'Initial commit' }
+      end
+
+      # Delete everything in the given directory, or the whole repo
+      def delete_all(dir = nil, options = {})
+        paths, options = clean_path(dir, options)
+        files = git("ls-files #{paths.first}")
+        FileUtils.rm_f files
+      end
+
       private
 
+      def remote_without_protocol
+        Pathname.new(remote.sub(/^.*:\/\//, ''))
+      end
+
       def create_gitignore
         c = Origen::Generator::Compiler.new
         c.compile "#{Origen.top}/templates/git/gitignore.erb",
@@ -204,10 +234,6 @@ module Origen
         end
       end
 
-      def initialized?
-        File.exist?("#{local}/.git")
-      end
-
       # Execute a git operation, the resultant output is returned in an array
       def git(command, options = {})
         options = {

data/templates/nanoc/Rules

@@ -36,14 +36,11 @@ compile '*' do
       filter :codeblocks
     end
     unless ["xml", "js"].include?(item[:extension])
-      if item[:layout] == "bootstrap"
+      if item[:layout] == "bootstrap" || item[:layout] == "bootstrap3" || !item[:layout]
         filter :bootstrap
         layout 'bootstrap'
-      elsif item[:layout] == "bootstrap3"
-        filter :bootstrap
-        layout 'bootstrap3'
-      elsif item[:layout] != "none"
-        layout 'freescale'
+      else
+        fail "Unknown web page layout: #{item[:layout]}"
       end
       filter :search
     end

data/templates/nanoc/layouts/bootstrap.html.erb

@@ -2,8 +2,11 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+
     <title><%= @item[:title] %></title>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <% if @item[:description] %>
       <meta name="description" content="<%= @item[:description] %>">
     <% end %>    
@@ -11,53 +14,47 @@
       <meta name="author" content="<%= @item[:author] %>">
     <% end %>
 
-    <!-- Le styles -->
-    <link href="http://rgen.freescale.net/css/bootstrap.min.css" rel="stylesheet">
-    <link href="http://rgen.freescale.net/css/bootstrap_custom.css" rel="stylesheet">
-    <link href="http://maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet">
+    <!-- Bootstrap core CSS -->
+    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
+    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap-theme.min.css">
+    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
+    <link rel="stylesheet" href="http://origen-sdk.org/css/bootstrap_custom.css"></script>
 
-    <!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
+    <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
     <!--[if lt IE 9]>
-      <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
     <![endif]-->
 
     <!-- Fav and touch icons -->
     <link rel="shortcut icon" href="http://rgen.freescale.net/favicon.ico"/>
     <link rel="icon" type="image/ico" href="http://rgen.freescale.net/favicon.ico"/>
-    <script src="http://rgen.freescale.net/js/jquery.min.js"></script>
-    <script src="http://rgen.freescale.net/js/bootstrap.min.js"></script>
   </head>
 
-  <body class="freescale">
-
-    <div id="wrap">
-      <div id="wrapper">
-        <div class="container" id="top-level-container">
-          <% if @item[:yammer_share].nil? || @item[:yammer_share] %>
-            <div id="yj-share-button"></div>
-          <% end %>
-          <%= yield %>
-        </div>
-
-        <div id="push"></div>
-      </div>
-    </div>
+  <body>
+    <% if @item[:full_width] %>
+      <%= yield %>
+    <% else %>
+      <div class="container">
+        <%= yield %>
+      </div><!-- /.container -->
+    <% end %>
 
-    <div id=footer>
-      <div class="container" style="padding-top:20px">
-        <p class="pull-left">
+    <footer class="footer">
+      <div class="container">
+        <p class="pull-left text-muted">
           Freescale Internal Use Only
         </p>
-        <p class="pull-right">&copy; Copyright <%= Time.now.year %> Freescale, Inc. All Rights Reserved</p>
+        <p class="pull-right text-muted">&copy; Copyright <%= Time.now.year %> Freescale, Inc. All Rights Reserved</p>
       </div>
-    <div>
-
-    <script src="http://rgen.freescale.net/js/lunr.min.js"></script>
-    <script src="http://rgen.freescale.net/js/highlight.js"></script>
-    <script src="http://rgen.freescale.net/js/custom.js"></script>
-    <% if @item[:yammer_share].nil? || @item[:yammer_share] %>
-      <script type="text/javascript" src="https://c64.assets-yammer.com/assets/platform_social_buttons.min.js"></script>
-      <script type="text/javascript">yam.platform.yammerShare();</script>
-    <% end %>
+    </footer>
+    <!-- Bootstrap core JavaScript
+    ================================================== -->
+    <!-- Placed at the end of the document so the pages load faster -->
+    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+    <script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
+    <script src="http://origen-sdk.org/js/lunr.min.js"></script>
+    <script src="http://origen-sdk.org/js/highlight.js"></script>
+    <script src="http://origen-sdk.org/js/custom.js"></script>
   </body>
 </html>

data/templates/shared/web/_logo.html

@@ -1,10 +1,10 @@
 <div class="pull-right logo-rgen" style="margin-top: 18px; margin-left: 10px">
-  <a href="http://rgen.freescale.net" style="text-decoration: none; color: #e66a08; font-weight: bold; font-size: 20px;">
-  <span>RGen</span>
+  <a href="http://origen-sdk.org" style="text-decoration: none; color: #e66a08; font-weight: bold; font-size: 20px;">
+  <span>Origen</span>
   </a>
 </div>
 <div class="pull-right">
-  <a href="http://rgen.freescale.net">
+  <a href="http://origen-sdk.org">
     <img src="http://rgen.freescale.net/img/fsl_logo.png" style="height:40px">
   </a>
 </div>

data/templates/web/archive.md.erb

@@ -0,0 +1,11 @@
+% render "layouts/basic.html", tab: :archive do
+
+## Archive
+
+Documentation from previous releases is available via the links below:
+
+% Origen.app.versions.reverse_each do |version|
+* [<%= version %>](<%= Origen.app.config.web_domain %>/<%= version.gsub(".", "_") %>)
+% end
+
+% end

data/templates/web/contact.md.erb

@@ -0,0 +1,40 @@
+% render "layouts/basic.html", tab: :contact do
+
+## Contact Us
+
+The following engineers can be contacted about this application:
+
+% Origen.app.developers.each do |user|
+%   if user.email
+* [<%= user.name %>](mailto:<%= user.email %>)
+%   else
+* <%= user.name %>
+%   end
+% end
+
+%# An example of how to manually write a more detailed contact page:
+%#Please use PDM For any bug reports or change/feature requests:
+%#
+%#* [C90TFS_NVM_tester on PDM](http://designpdm.freescale.net/Agile/PLMServlet?fromPCClient=true&module=PartFamilyHandler&requestUrl=module%3DPartFamilyHandler%26opcode%3DdisplayObject%26classid%3D2000004409%26objid%3D17718323%26tabid%3D2%26)
+%#
+%#For test related issues you can contact:
+%#
+%#* [Stephen McGinty](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\r49409) 
+%#* [Thao Huynh](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\R6AANF) 
+%#
+%#For product/yield issues contact:
+%#
+%#* [Andrew Hardell](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\R12635)
+%#* [Eddie Lepore](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\B06626)
+%#
+%#The manager of this project is:
+%#
+%#* [Wendy Malloch](http://freeshare.freescale.net:2222/my/Person.aspx?accountname=fsl\TTZ231)
+%#
+%#
+%#Finally if you are not sure who to contact, or if your question may have device/reliability
+%#implications, then you can use the Split Gate Flash Test and Reliability mailing list:
+%#
+%#* [Email SGFTANDR](mailto:SGFTANDR@freescale.com)
+
+% end

data/templates/web/docs/environment/definitions.md.erb

@@ -0,0 +1,17 @@
+% render "../../layouts/doc.html" do
+
+%# Add any new entries anywhere in this list, it will get sorted into
+%# alphabetical order during compilation:
+%
+% terms = {
+%   "Origen" => "A general purpose semiconductor engineering framework that uses the Ruby programming language, read more at http://origen.freescale.net",
+%   "Application" => "The generic name given to a project that uses Origen",
+% }
+
+| Term or Acronym | Definition
+|:----------------|:----------
+% terms.sort.each do |term|
+| <%= term[0] %> | <%= term[1] %>
+% end
+
+% end

data/templates/web/docs/environment/installation.md.erb

@@ -0,0 +1,22 @@
+% render "../../layouts/doc.html" do
+
+Follow the steps below to setup a new environment.
+
+#### 1. Install Origen
+
+Follow these instructions to install Origen: [How to Install Origen](http://origen.freescale.net/origen/latest/guides/starting/installing)
+
+#### 2. Create the application workspace
+
+This workspace must be situated outside of the Origen workspace that you have just created.
+
+Execute the following commands:
+
+~~~
+mkdir <%= Origen.app.name %>
+cd <%= Origen.app.name %>
+dssc setvault <%= Origen.config.vault %> .
+dssc pop -rec -uni -get -force -ver <%= Origen.app.version %> .
+~~~
+
+% end

data/templates/web/docs/environment/introduction.md.erb

@@ -0,0 +1,5 @@
+% render "../../layouts/doc.html" do
+
+Welcome to the docs...
+
+% end

data/templates/web/index.md.erb

@@ -0,0 +1,12 @@
+% render "layouts/basic.html" do
+
+%# HTML tags can be embedded in mark down files if you want to do specific custom
+%# formatting like this, but in most cases that is not required.
+<h1><%= Origen.app.namespace %> <span style="font-size: 14px">(<%= Origen.app.version %>)</span></h1>
+
+### Introduction
+
+Use this page to give a brief overview of what your application does, put the detail
+in the docs section.
+
+% end

data/templates/web/layouts/_basic.html.erb

@@ -0,0 +1,13 @@
+---
+title: <%= options[:title] || Origen.app.namespace %>
+---
+<%= render "templates/web/partials/navbar.html", tab: options[:tab] %>
+
+<div class="row">
+%# The markdown attribute is important if you are going to include content written
+%# in markdown, without this is will be included verbatim
+  <div class="span12" markdown="1">
+<%= yield %>    
+
+</div>
+</div>

data/templates/web/layouts/_doc.html.erb

@@ -0,0 +1,32 @@
+---
+title: <%= options[:title] || "#{Origen.app.namespace} - Docs" %>
+---
+<%= render "templates/web/partials/navbar.html", tab: :docs %>
+% s = {}
+
+%# This creates the index on the left of your doc pages
+%#
+%# Naming of the keys is very important and must be of the form:
+%#   <section>_<page> with no other underscores
+%# Origen will then look for the corresponding page in:
+%#   templates/web/docs/<section>/<page>.md.erb  
+%#  
+%# See here for more info: http://origen.freescale.net/doc_helpers/latest/examples/searchable/intro/
+
+% s["Environment"] = {
+%   environment_introduction: "Introduction",
+%   environment_installation: "Installation",
+%   environment_definitions: "Definitions and Acronyms",
+% }
+%
+%# Define additional sections as required, e.g.
+%# s["Registers"] = {
+%#   registers_map: "Register Map",
+%# }
+
+
+% #render "doc_helpers/searchable.html", options.merge(:index => s) do
+
+<%= yield %>
+
+% #end

data/templates/web/partials/_navbar.html.erb

@@ -0,0 +1,24 @@
+<nav class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="<%= path "/" %>">Home</a>
+    </div>
+    <div id="navbar" class="collapse navbar-collapse">
+      <ul class="nav navbar-nav">
+        <li class="<%= options[:tab] == :docs ? 'active' : '' %>"><a href="<%= path("/docs/environment/introduction") %>">Docs</a></li>
+        <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
+        <li class="<%= options[:tab] == :references ? 'active' : '' %>"><a href="<%= path "/references" %>">References</a></li>
+        <li class="<%= options[:tab] == :archive ? 'active' : '' %>"><a href="<%= path "/archive" %>">Archive</a></li>
+        <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
+        <li class="<%= options[:tab] == :contact ? 'active' : '' %>"><a href="<%= path "/contact" %>">Contact</a></li>
+      </ul>
+      <%= import "origen/web/logo.html" %>
+    </div><!--/.nav-collapse -->
+  </div>
+</nav>

data/templates/web/references.md.erb

@@ -0,0 +1,39 @@
+% render "layouts/basic.html", tab: :references do
+
+## References
+
+%# An example of how to write a references page:
+%#### Documents
+%#
+%#* Block Guides
+%#  * [FTFL Block Guide](http://compass.freescale.net/go/ftflspecs)
+%#  * [FTFE Block Guide](http://compass.freescale.net/go/ftfespecs)
+%#  * [FTFA Block Guide](http://compass.freescale.net/go/ftflspecs)
+%#* Hardmacro Creation Guides
+%#  * [TFSL Creation Guide](http://compass.freescale.net/go/tfsspec)
+%#  * [TFSE Creation Guide](http://compass.freescale.net/go/tfsspec)
+%#* Training
+%#  * [FTFL Overview](http://compass.freescale.net/livelink/livelink/207024304/FTFL_Overview.ppt?func=doc.Fetch&nodeid=207024304)
+%#* Quality  
+%#  * [Quality Level Cheatsheet](http://compass.freescale.net/livelink/livelink/227376170/SOC_3.6_NVM_Quality_Level_1409_C90TFS.xlsx?func=doc.Fetch&nodeid=227376170)
+%#
+%#### Origen
+%#  
+%#* [Origen Documentation](http://origen.freescale.net)
+%#* [Origen Freeshare Commmunity](http://freeshare.freescale.net:2222/public/origen-cmty-svc/Pages/PublicHome.aspx)
+%#
+%#### Design Sync Vaults
+%#
+%#* C90TFS NVM Test Module
+%#  * <%= Origen.config.vault %>
+%#* FTFL Design
+%#  * sync://sync-15040:15040/Projects/nvm_c90tfsw/ftfl
+%#  * sync://sync-15040:15040/Projects/nvm_c90tfsw/ftfl_firmware
+%#* FTFE Design
+%#  * sync://sync-15040:15040/Projects/nvm_c90ftfe/ftfe
+%#  * sync://sync-15040:15040/Projects/nvm_c90ftfe/ftfe_firmware
+%#* FTFA Design
+%#  * sync://sync-15040:15040/Projects/nvm_c90tfsw/ftfa
+%#  * sync://sync-15040:15040/Projects/nvm_c90tfsw/ftfa_firmware
+
+% end

data/templates/web/release_notes.md.erb

@@ -0,0 +1,5 @@
+% render "layouts/basic.html", tab: :release do
+
+<%= render "#{Origen.root}/doc/history" %>
+
+% end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -664,7 +664,7 @@ files:
 - lib/tasks/gem.rake
 - origen_site_config.yml
 - source_setup
-- spec/format/rgen_formatter.rb
+- spec/format/origen_formatter.rb
 - templates/api_doc/README.txt.erb
 - templates/code_generators/gemfile_app.rb
 - templates/code_generators/gemfile_plugin.rb
@@ -681,8 +681,6 @@ files:
 - templates/nanoc/config.yaml
 - templates/nanoc/content/favicon.ico
 - templates/nanoc/layouts/bootstrap.html.erb
-- templates/nanoc/layouts/bootstrap3.html.erb
-- templates/nanoc/layouts/freescale.html.erb
 - templates/nanoc/lib/bootstrap_filter.rb
 - templates/nanoc/lib/codeblocks_filter.rb
 - templates/nanoc/lib/default.rb
@@ -709,6 +707,17 @@ files:
 - templates/test/set3/content.html.erb
 - templates/time/filter.rb.erb
 - templates/time/rules.rb.erb
+- templates/web/archive.md.erb
+- templates/web/contact.md.erb
+- templates/web/docs/environment/definitions.md.erb
+- templates/web/docs/environment/installation.md.erb
+- templates/web/docs/environment/introduction.md.erb
+- templates/web/index.md.erb
+- templates/web/layouts/_basic.html.erb
+- templates/web/layouts/_doc.html.erb
+- templates/web/partials/_navbar.html.erb
+- templates/web/references.md.erb
+- templates/web/release_notes.md.erb
 homepage: http://origen-sdk.org
 licenses:
 - LGPL-3

data/templates/nanoc/layouts/bootstrap3.html.erb

@@ -1,71 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-
-    <title><%= @item[:title] %></title>
-    <% if @item[:description] %>
-      <meta name="description" content="<%= @item[:description] %>">
-    <% end %>    
-    <% if @item[:author] %>
-      <meta name="author" content="<%= @item[:author] %>">
-    <% end %>
-
-    <!-- Le styles -->
-    <link href="http://rgen.freescale.net/bootstrap/3.2.0/css/bootstrap.min.css" rel="stylesheet">
-    <link href="http://rgen.freescale.net/css/bootstrap_custom.css" rel="stylesheet">
-    <link href="http://maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet">
-
-    <!--[if lt IE 9]>
-      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
-      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
-    <![endif]-->
-    <!-- Fav and touch icons -->
-    <link rel="shortcut icon" href="http://rgen.freescale.net/favicon.ico"/>
-    <link rel="icon" type="image/ico" href="http://rgen.freescale.net/favicon.ico"/>
-  </head>
-
-  <body class="freescale">
-
-    <div id="wrap">
-      <div id="wrapper">
-        <% if @item[:full_width] %>
-          <% if @item[:yammer_share].nil? || @item[:yammer_share] %>
-            <div id="yj-share-button"></div>
-          <% end %>
-          <%= yield %>
-        <% else %>
-          <div class="container" id="top-level-container">
-            <% if @item[:yammer_share].nil? || @item[:yammer_share] %>
-              <div id="yj-share-button"></div>
-            <% end %>
-            <%= yield %>
-          </div>
-        <% end %>
-
-        <div id="push"></div>
-      </div>
-    </div>
-
-    <div id=footer>
-      <div class="container" style="padding-top:20px">
-        <p class="pull-left">
-          Freescale Internal Use Only
-        </p>
-        <p class="pull-right">&copy; Copyright <%= Time.now.year %> Freescale, Inc. All Rights Reserved</p>
-      </div>
-    <div>
-
-    <script src="http://rgen.freescale.net/js/jquery.min.js"></script>
-    <script src="http://rgen.freescale.net/bootstrap/3.2.0/js/bootstrap.min.js"></script>
-    <script src="http://rgen.freescale.net/js/lunr.min.js"></script>
-    <script src="http://rgen.freescale.net/js/highlight.js"></script>
-    <script src="http://rgen.freescale.net/js/custom.js"></script>
-    <% if @item[:yammer_share].nil? || @item[:yammer_share] %>
-      <script type="text/javascript" src="https://c64.assets-yammer.com/assets/platform_social_buttons.min.js"></script>
-      <script type="text/javascript">yam.platform.yammerShare();</script>
-    <% end %>
-  </body>
-</html>

data/templates/nanoc/layouts/freescale.html.erb

@@ -1,79 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <title><%= @item[:title] %></title>
-    <% if @item[:description] %>
-      <meta name="description" content="<%= @item[:description] %>">
-    <% end %>    
-    <% if @item[:author] %>
-      <meta name="author" content="<%= @item[:author] %>">
-    <% end %>
-    <link rel="shortcut icon" href="http://rgen.freescale.net/favicon.ico"/>
-    <link rel="icon" type="image/ico" href="http://rgen.freescale.net/favicon.ico"/>
-    <link href="http://swo.freescale.net/css/fsl.css" rel="stylesheet"
-    type="text/css" />
-    <link href="http://swo.freescale.net/css/leftnav.css" rel=
-    "stylesheet" type="text/css" />
-    <script language="JavaScript" src=
-    "http://swo.freescale.net/jscripts/FSLHeader.js" type=
-    "text/javascript">
-    </script>
-
-    <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
-    <!--[if lt IE 9]>
-      <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-
-    <link href="http://rgen.freescale.net/css/fsl.css" rel="stylesheet" type="text/css" media="all">
-  </head>
-
-  <body>
-    <a name="top" id="top"></a> 
-    <script language="JavaScript" type="text/javascript">
-     HideDropDowns = true;
-     WriteFSHeader();
-    </script>
-    <table width="100%">
-      <tr>
-        <td valign="top"><!-- BEGIN LEFT NAVIGATION, IF DESIRED -->
-        </td>
-
-        <td width="100%" valign="top">
-          <% if false %>
-            <div class="breadcrumbs">
-              <a href="index.htm">Home Page</a>
-              This Page
-            </div>
-          <% end %>
-          <!-- Page Header -->
-          <table width="100%">
-            <tr>
-              <td>
-                <h1><%= @item[:title] %></h1>
-              </td>
-            </tr>
-          </table>
-
-          <table width="100%">
-            <tr><!-- Begin Left Column -->
-              <td valign="top">
-                <%= yield %>
-              </td>
-            </tr>
-          </table>
-
-        </td>
-      </tr>
-    </table>
-    <div>
-      <p>Generated with <a href="http://rgen.freescale.net" target="_blank" title="RGen">RGen</a>
-      </p>
-    </div>
-    <script language="JavaScript" type="text/javascript">
-     Contact = 'mailto:stephen.mcginty@freescale.com';
-     POPI = "FIUO"
-     WriteFooter();
-    </script>
-  </body>
-</html>