Finish usermanual update

Author: Redande

bin/spec_usermanual

@@ -1,4 +1,4 @@
 #!/bin/sh
 
-RSPEC_PATTERN="spec/usermanual/usermanual_spec.rb"
+RSPEC_PATTERN="spec/usermanual/**/*.rb"
 bundle exec rake spec SPEC_OPTS="--pattern $RSPEC_PATTERN --format documentation"

doc/usermanual/css/usermanual.css

@@ -23,7 +23,7 @@ body p, li {
   max-width: 600px;
 }
 
-body ul, p, h1, h2, h3, h4, h5, h6 {
+body ul, p, h1, h2, h3, h4, h5, h6, hr {
   max-width: 600px;
   margin-left: 30px;
   margin-right: 30px;
@@ -43,11 +43,12 @@ body > div {
 }
 
 img.screenshot {
-  border: 3px solid gray;
+  border: 1px solid gray;
   display: block;
-  max-width: 1000px;
-  margin-left: auto;
+  max-width: 800px;
+  margin-left: 30px;
   margin-right: auto;
+  margin-top: 1em;
   margin-bottom: 3em;
 }
 

lib/doc_gen.rb

@@ -27,7 +27,7 @@ def render_template(template_path)
 
   def screenshot(_options = {})
     name = next_screenshot_name
-    screenshot_to_file("#{root_path}/screenshots/#{name}")
+    screenshot_to_file("#{root_path}/screenshots/#{name}", _options)
     '<img src="screenshots/' + name + '" alt="(screenshot)" class="screenshot" />'
   end
 
@@ -54,8 +54,11 @@ def next_screenshot_name
       "#{@doc_name}-#{@img_counter}.png"
     end
 
-    def screenshot_to_file(path)
+    def screenshot_to_file(path, _options)
+      default_options = { full: true }
+      options = default_options.merge(_options)
       FileUtils.mkdir_p(File.dirname(path))
-      @test_case.page.save_screenshot(path)
+      options[:wide] ? @test_case.page.driver.browser.resize(1200, 800) : @test_case.page.driver.browser.resize(1024, 768)
+      @test_case.page.save_screenshot(path, :full => options[:full])
     end
 end

lib/doc_gen/shell_session.rb

@@ -29,7 +29,7 @@ class ExampleBlock
 
         def initialize(session)
           @session = session
-          @transcript = ''
+          @transcript = ''.dup
         end
 
         def blank_line

spec/spec_helper.rb

@@ -31,7 +31,7 @@
 # In console 1: Xvfb :99
 # In console 2: env DISPLAY=:99 rvmsudo rake spec
 Capybara.register_driver :poltergeist do |app|
-  Capybara::Poltergeist::Driver.new(app, timeout: 60, js_errors: false, window_size: [1920, 1920])
+  Capybara::Poltergeist::Driver.new(app, timeout: 60, js_errors: false)
 end
 
 Capybara.default_driver = :poltergeist

spec/usermanual/admins.html.erb

@@ -55,9 +55,9 @@ require 'cgi' # for escapeHTML
   <h2>Course templates</h2>
 
   <p>
-    Simplest way to create a course is to copy it from a template. This way teacher won't
-    have to create new repositories from which new course will be based off. One of the biggest
-    responsibilities for an administrator is managing these templates in TMC webapp.
+    The simplest way to create a course is to copy it from a template. This way teachers won't
+    have to create new exercise repositories for their courses. One of the biggest
+    responsibilities for an administrator is managing course templates in the TMC webapp.
   </p>
 
   <p>
@@ -72,7 +72,7 @@ require 'cgi' # for escapeHTML
    visit '/course_templates'
    highlight 'a:contains("New Course template")'
 %>
-<%= screenshot %>
+<%= screenshot(wide: true) %>
 
   <p>
     This page lists all course templates in the database with their relevant information.
@@ -105,11 +105,11 @@ require 'cgi' # for escapeHTML
       <li><b>Title</b> is a prettier version of the name that may contain whitespaces, and is shown on webapp pages.</li>
       <li><b>Description</b> is a short piece of text to show when browsing this particular course.</li>
       <li>
-        <b>Material url</b> takes user to the online resource that educates and helps the course participant with solving
+        <b>Material url</b> takes the user to the online resource that educates and helps the course participant with solving
         the course exercises.
       </li>
       <li>
-        <b>Source url</b> is a remote repository from which student will pull exercises as source files.
+        <b>Source url</b> is a remote repository from which students will pull exercises as source files.
         When this field is edited, TMC webapp will validate the url by attempting to clone the repository from the url.
         You can find information on how to create a course repository by yourself from this <a href="customcourse.html#starting_from_a_template">guide</a>.
       </li>
@@ -118,7 +118,7 @@ require 'cgi' # for escapeHTML
         Default value is master.
       </li>
       <li>
-        After the <b>Expires at</b> date no courses can be cloned from the expired template. Expiration date will not affect courses
+        After the <b>Expires at</b> date, no courses can be cloned from the expired template. Expiration date will not affect courses
         that were cloned before the expiration date.
       </li>
     </ul>
@@ -142,7 +142,7 @@ require 'cgi' # for escapeHTML
    highlight 'a:contains("Edit"):first'
    highlight 'a:contains("unhide")'
 %>
-<%= screenshot %>
+<%= screenshot(wide: true) %>
 
   <p>
     Whenever any changes to the remote repository are made (new exercises added, exercises removed, etc),
@@ -152,7 +152,7 @@ require 'cgi' # for escapeHTML
   </p>
 
   <p>
-    Course template default fields may be edited at any time by administrator via link 'Edit'. Expiration date
+    Course template default fields may be edited at any time by administrator via the link 'Edit'. Expiration date
     may be changed through the same link.
   </p>
 
@@ -168,12 +168,12 @@ require 'cgi' # for escapeHTML
     or disabled. Anyone can create a new organization, so they should be verified through careful consideration.
   </p>
 
-  <p>Administrator will see this notice on the front page when there are any unverified new organizations:</p>
+  <p>Administrators will see this notice on the front page when there are any unverified new organizations:</p>
 
 <%
   FactoryBot.create :user, login: 'user', password: 'user'
 
-  click_on 'Sign out'
+  visit '/logout'
   visit '/login'
   fill_in 'username', with: 'user'
   fill_in 'password', with: 'user'
@@ -186,7 +186,7 @@ require 'cgi' # for escapeHTML
   click_button 'Create Organization'
   expect(page).to have_content 'Organization was successfully created.'
 
-  click_on 'Sign out'
+  visit '/logout'
   visit '/login'
   fill_in 'username', with: 'admin'
   fill_in 'password', with: 'admin'
@@ -225,7 +225,7 @@ require 'cgi' # for escapeHTML
 
 <%
   Organization.find_by(slug: 'hy').destroy!
-  click_on 'Sign out'
+  visit '/logout'
   visit '/login'
   fill_in 'username', with: 'user'
   fill_in 'password', with: 'user'
@@ -238,7 +238,7 @@ require 'cgi' # for escapeHTML
   click_button 'Create Organization'
   expect(page).to have_content 'Organization was successfully created.'
 
-  click_on 'Sign out'
+  visit '/logout'
   visit '/login'
   fill_in 'username', with: 'admin'
   fill_in 'password', with: 'admin'
@@ -261,7 +261,7 @@ require 'cgi' # for escapeHTML
 %>
 <%= screenshot %>
 
-<p>Disabled organization will not be shown anywhere in the front page.</p>
+<p>Disabled organizations will not be shown anywhere in the front page.</p>
 
 <%
   visit '/'
@@ -271,7 +271,7 @@ require 'cgi' # for escapeHTML
 <h2>Monitoring background refreshes</h2>
 
 <p>
-  When a new course is made, first real-time refresh is made only partly, without generating available points for exercises. Because of that, full refresh is launched on background. As administrator, the front page shows if there are any ongoing background refreshes, and when they are made. Based on that, you can monitor possible problems, if certain course stays on the refresh list for too long time.
+  When a new course is made, first real-time refresh is made only partly, without generating available points for exercises. Because of that, full refresh is launched on background. As administrator, the front page shows if there are any ongoing background refreshes, and when they were made. Based on that, you can monitor possible problems, if certain course stays on the refresh list for too long.
 </p>
 
 <%

spec/usermanual/customcourse.html.erb

@@ -34,7 +34,7 @@ require 'cgi' # for escapeHTML
 
   <%
     teacher = FactoryBot.create(:admin, :login => 'teacher', :password => 'teacher')
-    org = FactoryBot.create(:accepted_organization, name: 'Some organization')
+    org = FactoryBot.create(:accepted_organization, name: 'Some organization', slug: 'someorg', information: 'A short description of this organization.')
     org.teachers << teacher
     org.save
   %>
@@ -56,11 +56,14 @@ require 'cgi' # for escapeHTML
   <p>Let's log in as a teacher of some organization.</p>
 
   <%
-    visit "/org/#{org.slug}"
-    screenshot
     visit "/login"
     fill_in 'email', :with => 'teacher'
     fill_in 'password', :with => 'teacher'
+  %>
+
+  <%= screenshot %>
+
+  <%
     click_on 'Sign in'
     visit "/org/#{org.slug}"
   %>
@@ -99,7 +102,7 @@ require 'cgi' # for escapeHTML
     repo_path = ENV['TMC_USERMANUAL_REPO_PATH'] || (ENV['HOME'] + '/tmc-example-repo')
     FileUtils.rm_rf(repo_path)
     FileUtils.mkdir_p(repo_path)
-    create_bare_repo(repo_path, initial_commit: true)
+    create_bare_repo(repo_path)
     repo_url = 'file://' + repo_path
 
     fill_in 'course_source_url', :with => repo_url
@@ -126,6 +129,8 @@ require 'cgi' # for escapeHTML
 
     click_button 'Continue'
     click_button 'Publish now'
+
+    RefreshCourseTask.new.run
   %>
 
   <p>
@@ -288,19 +293,28 @@ require 'cgi' # for escapeHTML
   <% visit "/org/#{org.slug}/courses/#{course.id}/" %>
   <% highlight('a:contains("Refresh")') %>
   <%= screenshot %>
-  <% click_on 'Refresh' %>
-  <% course.reload %>
+  <%
+    click_on 'Refresh'
+
+    RefreshCourseTask.new.run
+
+    course.reload
+
+    course.exercises.update_all(disabled_status: 0)
+  %>
 
   <p>
     The system now reloads all exercises from the repository and rebuilds its
     internal caches. Any submissions made to previous exercises will survive this process,
     even if the exercise is deleted in the push.
   </p>
 
+  <% visit "/org/#{org.slug}/courses/#{course.id}/" %>
+
   <%= screenshot %>
 
   <p>
-    The exercise should now be available for download and accept submissions.
+    The exercises should now be available for download and they should accept submissions.
   </p>
 
   <h2>Personalized course progression</h2>
@@ -387,9 +401,9 @@ deadline:
 
   <h2>Special comments</h2>
 
-  <p>
+  <b>
     See all available special comments <a href="https://github.com/rage/tmc-langs-rust/blob/master/docs/exercise%20template%20annotations.md">here</a>.
-  </p>
+  </b>
 
   <p>
     Solution code can be demarcated with special comments so it will be removed from