Skip to content

Commit

Permalink
Instructions for service form management
Browse files Browse the repository at this point in the history
  • Loading branch information
moveson committed Dec 18, 2024
1 parent 26867e1 commit 7b74df0
Show file tree
Hide file tree
Showing 8 changed files with 156 additions and 6 deletions.
4 changes: 4 additions & 0 deletions app/controllers/docs/visitors_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ def api
render_using_presenter(Docs::ApiPresenter)
end

def user_info
render_using_presenter(Docs::UserInfoPresenter)
end

private

def render_using_presenter(presenter)
Expand Down
2 changes: 1 addition & 1 deletion app/presenters/docs/contents_presenter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def display_category

def items
{
contents: {display_topic: "Contents", pages: ["Categories"]}
contents: { display_topic: "Contents", pages: ["Categories"] }
}
end
end
Expand Down
19 changes: 19 additions & 0 deletions app/presenters/docs/user_info_presenter.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# frozen_string_literal: true

module Docs
class UserInfoPresenter < Docs::BasePresenter
def category
:user_info
end

def display_category
"User Information"
end

def items
{
lotteries: { display_topic: "Lotteries", pages: ["Managing service requirements"] },
}
end
end
end
20 changes: 15 additions & 5 deletions app/views/docs/visitors/_contents_contents_1.html.erb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div class="card">
<h4 class="card-header"><%= link_to 'Getting Started', docs_getting_started_path %></h4>
<h4 class="card-header"><%= link_to "Getting Started", docs_getting_started_path %></h4>
<div class="card-body">
<p>
The basics of creating your event and understanding terms used on the site.
Expand All @@ -9,7 +9,7 @@
<br/>

<div class="card">
<h4 class="card-header"><%= link_to 'Managing an Event', docs_management_path %></h4>
<h4 class="card-header"><%= link_to "Managing an Event", docs_management_path %></h4>
<div class="card-body">
<p>
Checking in, starting, monitoring, and closing down your event.
Expand All @@ -19,7 +19,7 @@
<br/>

<div class="card">
<h4 class="card-header"><%= link_to 'OST Remote', docs_ost_remote_path %></h4>
<h4 class="card-header"><%= link_to "OST Remote", docs_ost_remote_path %></h4>
<div class="card-body">
<p>
Full documentation for OST Remote, the easiest way to enter live time entries.
Expand All @@ -29,7 +29,7 @@
<br/>

<div class="card">
<h4 class="card-header"><%= link_to 'The OpenSplitTime API', docs_api_path %></h4>
<h4 class="card-header"><%= link_to "The OpenSplitTime API", docs_api_path %></h4>
<div class="card-body">
<p>
How to use the OpenSplitTime API.
Expand All @@ -38,10 +38,20 @@
</div>
<br/>

<div class="card">
<h4 class="card-header"><%= link_to "User Information", docs_user_info_path %></h4>
<div class="card-body">
<p>
Navigating OpenSplitTime as a User.
</p>
</div>
</div>
<br/>

<div class="card">
<h4 class="card-header">Getting Help</h4>
<div class="card-body">
<p>If you have any questions, please <%= mail_to '[email protected]', 'contact us' %> and we will do our best to
<p>If you have any questions, please <%= mail_to "[email protected]", "contact us" %> and we will do our best to
help.</p>
</div>
</div>
100 changes: 100 additions & 0 deletions app/views/docs/visitors/_user_info_lotteries_1.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<div class="card">
<h4 class="card-header">Service Requirements</h4>
<div class="card-body">
<p>For entrants who are accepted or placed on a waitlist, OpenSplitTime provides organizers with a way of keeping track of service requirements.
Once a Lottery is finished and the organizer has uploaded a service form, entrants can download that form, fill it out, complete it, and then
upload a completed form.</p>
</div>
</div>
<br/>

<div class="card">
<h4 class="card-header">Downloading a Service Form</h4>
<div class="card-body">
<p>If you have been accepted or waitlisted, and you need to download a service form, <span class="fw-bold">here are the steps:</span></p>
<ol>
<li>If you already have an OpenSplitTime account,
<span class="fw-bold">
<%= user_signed_in? ?
"log in to OpenSplitTime" :
link_to("log in to OpenSplitTime", new_user_session_path, data: { turbo_frame: :form_modal })
%>.
</span>
The email address you use for your OpenSplitTime User account will need to be the same as the email address you used to sign up for the event.
</li>
<li>If you do not already have an OpenSplitTime account, or if you have an OpenSplitTime account under a different email address, you will
need to
<span class="fw-bold">
<%= user_signed_in? ?
"sign up to OpenSplitTime" :
link_to("sign up to OpenSplitTime", new_user_registration_path)
%>.
</span>
</li>
<li>Click on the <span class="fw-bold"><%= user_signed_in? ? link_to("My Stuff", my_stuff_path) : "My Stuff" %></span> link in the navigation
bar at the top of the page.
</li>
<li>Under the "Manage Service" card, click the appropriate link. This will take you to your Manage Service page.</li>
<li>Alternatively, you can search for your name in the Lottery Entrants page, click to expand the card to show details, and click the "Manage
Service" button that appears on that card.
</li>
<li>Click the "Download" link to download a blank service form.</li>
<li>The form information may be filled out electronically, but <span class="fw-bold">all signatures must be manually obtained.</span> Electronic
signatures are not supported.
</li>
</ol>
</div>
</div>
<br/>

<div class="card">
<h4 class="card-header">Uploading a Completed Service Form</h4>
<div class="card-body">
<p>Once you have your service form completed and signed by all appropriate parties,
<span class="fw-bold">here are the steps to upload the completed form:</span></p>
<ol>
<li>Scan or take a photo of your completed form. <span class="fw-bold">The format must be jpeg, png, or pdf, and the file size must be less than 2 MB.</span></li>
<li>
<span class="fw-bold">
<%= user_signed_in? ?
"Log in to OpenSplitTime" :
link_to("Log in to OpenSplitTime", new_user_session_path, data: { turbo_frame: :form_modal })
%>
</span>
using the same account you used to download the form.</li>
<li>Navigate to your Manage Service page as described above, and find the card with the heading that says, "Upload Completed Service Form".</li>
<li>Drag your completed service form to the dropzone area, or click/tap the area and browse to find your file.</li>
<li><span class="fw-bold">Click/tap the "Attach" button</span> at the bottom of the card.</li>
<li>The page will reload, and you should see "Under Review" in the Status card at the top of the page.</li>
</ol>
</div>
</div>
<br/>

<div class="card">
<h4 class="card-header">Service Form Review</h4>
<div class="card-body">
<p>Your form will be reviewed and either approved or rejected. It may take several days for the review process to be complete.
<span class="fw-bold">Please submit your form early to allow plenty of time for review and to provide any needed corrections.</span></p>
<p>If the form is rejected, you will see comments giving a description of the reason for the rejection.
<span class="fw-bold">If your form is rejected, you will need to click "Remove" to delete the form,</span> fix the problems,
and then <span class="fw-bold">upload a corrected form.</span></p>
</div>
</div>
<br/>

<div class="card">
<h4 class="card-header">How to Get Your Form Accepted the First Time</h4>
<div class="card-body">
<p>Here are some things to keep in mind before submitting your service form:</p>
<ol>
<li><span class="fw-bold">Don't use an outdated form.</span> Make sure you download the current form from the "Manage Service" page. Don't use a
form from a previous year. It will be rejected.
</li>
<li><span class="fw-bold">Fill out the form completely.</span> A form will be rejected if all the necessary information is not provided.</li>
<li><span class="fw-bold">Get all your signatures.</span> A form will be rejected if it is not fully signed.</li>
<li><span class="fw-bold">Submit your form on time.</span> Forms submitted after the deadline will be rejected.</li>
</ol>
</div>
</div>
<br/>
11 changes: 11 additions & 0 deletions app/views/lotteries/show.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,17 @@
<% end %>

<% when "results" %>
<% if @presenter.lottery.finished? && @presenter.lottery.service_form.attached? %>
<%= render partial: "shared/callout_with_link",
locals: {
icon_name: "info-circle",
icon_color: "info",
callout_color: "info",
main_text: t(".callout_main_text"),
detail_paragraphs: t(".callout_detail_paragraph_1"),
link: link_to("Learn more", docs_user_info_path, class: "btn btn-outline-primary")
} %>
<% end %>
<h4 class="mt-5">
<span class="fw-bold">Lottery Results</span><span class="px-1 h5 fw-light text-muted"><%= " Last updated #{time_ago_in_words(@presenter.lottery.updated_at)} ago" %></span>
</h4>
Expand Down
5 changes: 5 additions & 0 deletions config/locales/views.en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ en:
new:
callout_detail_paragraph: 'Import Jobs run in the background, allowing you to do other work while the import is ongoing. You can check the status of any of your import jobs at any time by clicking "Imports" on the top menu bar.'

lotteries:
show:
callout_main_text: "Service form is now available for download"
callout_detail_paragraph_1: "For those accepted to the lottery or waitlisted, the service form is now available for download from your Manage Service page. When the form is complete with all signatures in place, you will upload the form from the same Manage Service page."

people:
show:
confirm_person_claimed: "This action will associate your user (%{user_email}) with %{person_full_name}. This will allow you to quickly access your results, lottery service requirements, and other information from the My Stuff view. Please ensure this is really you before claiming this Person. This action can be undone only by a site administrator.\n\nClick OK to complete the assignment or Cancel to return without assigning."
Expand Down
1 change: 1 addition & 0 deletions config/routes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
get "management", to: "visitors#management"
get "ost_remote", to: "visitors#ost_remote"
get "api", to: "visitors#api"
get "user_info", to: "visitors#user_info"
end

scope :my_stuff, controller: :my_stuff, as: :my_stuff do
Expand Down

0 comments on commit 7b74df0

Please sign in to comment.