Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
### 🚨 Breaking changes

### ✨ New features and improvements
- Updated links to refer to new documentation website (#8049)
- Migrated `AnnotationUsagePanel` component to use `react-table` v8 (#8021)
- Migrated `SummaryPanel` component to React Table V8 (#8019)
- Migrated `graders_manager.jsx` file's `GradersTable`, `GroupsTable`, `CriteriaTable` to use `react-table` v8 (#8014)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,7 @@ export class GraderDistributionModal extends React.Component {
<h2>{I18n.t("graders.weight")}</h2>
<p className="auto-overflow" style={{maxWidth: "300px"}}>
{I18n.t("graders.random_instruction")}
<a
href={`https://github.com/MarkUsProject/Wiki/blob/${MARKUS_VERSION}/Instructor-Guide--Assignments--Assigning-Graders.md`}
>
<a href={`${DOCS_URL}/instructors/assignments/assigning-graders/`}>
{" " + I18n.t("graders.wiki")}
</a>
</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ describe("GraderDistributionModal", () => {
isOpen: true,
onSubmit: jest.fn().mockImplementation(() => (props.isOpen = false)),
};
global.MARKUS_VERSION = "master";
jest.spyOn(window, "FormData").mockImplementationOnce(() => form1);
});

Expand Down
2 changes: 1 addition & 1 deletion app/views/admin/users/_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<%= content_for :modal_content do %>

<p>
<%= t('users.admin_csv_upload_help_html', markus_version: Rails.configuration.markus_version) %>
<%= t('users.admin_csv_upload_help_html', docs_url: Settings.docs_url) %>
</p>
<%= form_tag upload_admin_users_path, { multipart: true } do %>
<div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<%= content_for :modal_content do %>

<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: AnnotationCategory.name.pluralize.underscore.dasherize) %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: AnnotationCategory.name.pluralize.underscore.dasherize) %>
<%= form_tag({ action: 'upload' },
{ multipart: true }) do %>
<p><%= file_field_tag :upload_file, required: true, accept: '.csv,.yml,.yaml' %></p>
Expand Down
2 changes: 1 addition & 1 deletion app/views/assignments/_assignment_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<%= content_for :modal_content do %>

<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: Assignment.name.pluralize.underscore.dasherize) %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: Assignment.name.pluralize.underscore.dasherize) %>

<%= form_tag upload_assignments_course_path(@current_course),
{ multipart: true } do %>
Expand Down
2 changes: 1 addition & 1 deletion app/views/assignments/_cp_assignment_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<%= content_for :modal_content do %>

<%= t('assignments.upload_config_help_html', markus_version: Rails.configuration.markus_version, section_id: 'assignment-configuration') %>
<%= t('assignments.upload_config_help_html', docs_url: Settings.docs_url, section_id: 'assignment-configuration') %>

<%= form_tag upload_config_files_course_assignments_path(@current_course),
{ multipart: true } do %>
Expand Down
2 changes: 1 addition & 1 deletion app/views/criteria/_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<p><%= t('assignments.due_date.marking_overwrite_warning_html') %></p>
</div>
<% end %>
<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: Criterion.name.pluralize.underscore.dasherize) %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: Criterion.name.pluralize.underscore.dasherize) %>
<%= form_tag upload_course_assignment_criteria_path(@current_course, @assignment),
multipart: true, size: 1 do %>
<p><%= file_field_tag :upload_file, required: true, accept: '.yaml,.yml' %></p>
Expand Down
2 changes: 1 addition & 1 deletion app/views/exam_templates/_manager_help.html.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div id='exam_template_help'>
<h2><%= t(:help) %></h2>
<%= t('exam_templates.help_manual_html',
markus_version: Rails.configuration.markus_version,
docs_url: Settings.docs_url,
template_division_title: ExamTemplate.human_attribute_name('template_divisions'),
automatic_parsing_title: t('exam_templates.parsing.title')) %>
</div>
2 changes: 1 addition & 1 deletion app/views/grade_entry_forms/_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<%= content_for :modal_open_link, '#uploadModal' %>

<%= content_for :modal_content do %>
<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: 'marks-spreadsheet-grades') %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: 'marks-spreadsheet-grades') %>

<%= form_tag upload_course_grade_entry_form_path(@current_course, @grade_entry_form),
{ multipart: true, size: 1 } do %>
Expand Down
2 changes: 1 addition & 1 deletion app/views/graders/_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<%= content_for :modal_content do %>

<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: 'graders') %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: 'graders') %>

<%= form_tag upload_course_assignment_graders_path(@current_course, @assignment),
{ multipart: true } do %>
Expand Down
2 changes: 1 addition & 1 deletion app/views/groups/_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<%= content_for :modal_content do %>

<p>
<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: 'groups') %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: 'groups') %>
</p>
<%= form_tag upload_course_assignment_groups_path(@current_course, @assignment),
{ multipart: true } do %>
Expand Down
2 changes: 1 addition & 1 deletion app/views/layouts/_head.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@
<% end %>
<%= javascript_tag("const AUTH_TOKEN = document.querySelector('[name=\"csrf-token\"]').content;", nonce: true) if protect_against_forgery? %>
<%= javascript_tag nonce: true do %>
const MARKUS_VERSION = '<%= Rails.configuration.markus_version %>';
const DOCS_URL = '<%= Settings.docs_url %>';
const I18N_LOCALE = '<%= I18n.locale %>';
<% end %>
2 changes: 1 addition & 1 deletion app/views/layouts/_header.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
<% end %>
<li>
<i class="fa-solid fa-question"></i>
<a href="https://github.com/MarkUsProject/Wiki/blob/<%= Rails.configuration.markus_version %>/Home.md">
<a href="<%= Settings.docs_url %>">
<%= t(:help) %>
</a>
</li>
Expand Down
2 changes: 1 addition & 1 deletion app/views/marks_graders/_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<%= content_for :modal_open_link, '#uploadModal' %>

<%= content_for :modal_content do %>
<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: 'graders') %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: 'graders') %>

<%= form_tag({ controller: 'marks_graders',
action: 'upload' },
Expand Down
2 changes: 1 addition & 1 deletion app/views/peer_reviews/_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<%= content_for :modal_content do %>

<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: 'peer-reviews') %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: 'peer-reviews') %>

<%= form_tag({ controller: 'peer_reviews',
action: 'upload' },
Expand Down
2 changes: 1 addition & 1 deletion app/views/students/_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<%= content_for :modal_content do %>

<p>
<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: 'students') %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: 'students') %>
</p>
<%= form_tag upload_course_students_path(@current_course), { multipart: true } do %>
<div>
Expand Down
2 changes: 1 addition & 1 deletion app/views/tags/_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<%= content_for :modal_content do %>

<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: 'tags') %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: 'tags') %>

<%= form_tag upload_course_tags_path(@current_course, assignment_id: @assignment.id),
{ multipart: true, size: 1 } do %>
Expand Down
2 changes: 1 addition & 1 deletion app/views/tas/_upload_modal.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<%= content_for :modal_content do %>
<p>
<%= t('upload_help_html', markus_version: Rails.configuration.markus_version, section_id: 'students') %>
<%= t('upload_help_html', docs_url: Settings.docs_url, section_id: 'tas') %>
</p>
<%= form_tag upload_course_tas_path(@current_course), { multipart: true } do %>
<div>
Expand Down
2 changes: 1 addition & 1 deletion app/views/users/_key_display.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<%= User.human_attribute_name(:api_key) %>
<div class='help'>
<p>
<%= t('users.api_key.help_html', markus_version: Rails.configuration.markus_version,) %>
<%= t('users.api_key.help_html', docs_url: Settings.docs_url,) %>
</p>
</div>
</h2>
Expand Down
4 changes: 2 additions & 2 deletions app/views/users/settings.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@
<hr>
<h3><%= t('help') %></h3>
<p>
<a href="https://github.com/MarkUsProject/Wiki/blob/<%= Rails.configuration.markus_version %>/SSH_Keypair_Instructions_Windows.md" target="_blank">
<a href="<%= Settings.docs_url %>/instructors/key-pairs/windows/" target="_blank">
<%= t('key_pairs.help.windows') %>
</a>
</p>
<p>
<a href="https://github.com/MarkUsProject/Wiki/blob/<%= Rails.configuration.markus_version %>/SSH_Keypair_Instructions_Linux-OSX.md" target="_blank">
<a href="<%= Settings.docs_url %>/instructors/key-pairs/linux-osx/" target="_blank">
<%= t('key_pairs.help.macOS_linux') %>
</a>
</p>
Expand Down
1 change: 1 addition & 0 deletions config/initializers/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@
optional(:lti).filled(:string)
optional(:repos).filled(:string)
end
optional(:docs_url).filled(:string)
optional(:lti).hash do
optional(:course_filter_file).filled(:string)
required(:domains).array(:str?)
Expand Down
2 changes: 1 addition & 1 deletion config/locales/defaults/download_upload/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ en:
unparseable_csv: The selected file is not a CSV file (even though it may have a .csv extension).
zip_entry_too_large: Zip entry %{file_name} exceeds the maximum file size of %{max_size} MB.
zip_too_large_total: Zip file uncompressed size exceeds the maximum of %{max_mb} MB.
upload_help_html: ' For information about the file format(s) supported, please visit <a href="https://github.com/MarkUsProject/Wiki/blob/%{markus_version}/Instructor-Guide--Importing-and-Exporting-Data.md#%{section_id}">this page</a>.'
upload_help_html: ' For information about the file format(s) supported, please visit <a href="%{docs_url}/instructors/importing-and-exporting-data/#%{section_id}">this page</a>.'
upload_success:
one: "%{count} object successfully uploaded."
other: "%{count} objects successfully uploaded."
Expand Down
2 changes: 1 addition & 1 deletion config/locales/views/admin/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ en:
markus_administration: MarkUs Administration
monitoring: Monitoring
users:
admin_csv_upload_help_html: For more information about this feature and the<br>file format(s) supported, please visit <a href="https://github.com/MarkUsProject/Wiki/blob/%{markus_version}/Admin-Guide.md#bulk-uploading-of-end-users">this page</a>.
admin_csv_upload_help_html: For more information about this feature and the<br>file format(s) supported, please visit <a href="%{docs_url}/administrators/#bulk-uploading-of-end-users">this page</a>.
2 changes: 1 addition & 1 deletion config/locales/views/assignments/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ en:
upload_config_files:
errors:
invalid_starter_file_group_dirname: 'Invalid directory_name for starter file group: %{directory_name}'
upload_config_help_html: "<p>This zip file will configure and create this assignment.</p><p>This does not configure student or grader settings.<br>For more information please visit <a href=https://github.com/MarkUsProject/Wiki/blob/%{markus_version}/Instructor-Guide--Importing-and-Exporting-Data.md#%{section_id}>this page</a>.</p>"
upload_config_help_html: <p>This zip file will configure and create this assignment.</p><p>This does not configure student or grader settings.<br>For more information please visit <a href="%{docs_url}/instructors/importing-and-exporting-data/#%{section_id}">this page</a>.</p>
upload_file_requirement: Filename %{file_name} is not allowed for this assignment.
upload_file_requirement_in_folder: Filename %{file_name} in %{file_path} is not allowed for this assignment.
upload_grades:
Expand Down
4 changes: 2 additions & 2 deletions config/locales/views/exam_templates/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ en:
title: Generate Exam Copies
help_manual_html: |
<p>
For more details on any of these steps and more, please visit the <a href=https://github.com/MarkUsProject/Wiki/blob/%{markus_version}/Instructor-Guide--Scanned-Exams.md>MarkUs wiki</a>.
For more details on any of these steps and more, please visit the <a href="%{docs_url}/instructors/scanned-exams/">MarkUs documentation website</a>.
</p> <h3>Editing Exam Templates</h3> <p>
Select an Exam Template on the left to edit it. In addition to changing the name and template file you may also
make changes to the following:
Expand All @@ -68,7 +68,7 @@ en:
If enabled, MarkUs will attempt to scan a portion of the test cover page and parse handwriting corresponding
to either a student's user name or ID number. MarkUs will then attempt to match the test paper to a student
in the course. This feature is not designed to replace the manual matching process. For more details please
consult the <a href=https://github.com/MarkUsProject/Wiki/blob/%{markus_version}/Instructor-Guide--Scanned-Exams.md#automatic-parsing-of-student-information>wiki</a>.
consult the <a href="%{docs_url}/instructors/scanned-exams/#automatic-matching-of-student-papers">documentation</a>.
</p>
</li>
</ul> <h3>Uploading Completed Test Papers</h3> <p>
Expand Down
2 changes: 1 addition & 1 deletion config/locales/views/graders/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ en:
upload:
remove_existing_mappings: Remove existing grader assignments
weight: Grader Weight
wiki: See our wiki for more information.
wiki: See our documentation website for more information.
2 changes: 1 addition & 1 deletion config/locales/views/users/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ en:
users:
account_settings: Account Settings
api_key:
help_html: The API key is used for authentication for the MarkUs API. See <a href="https://github.com/MarkUsProject/Wiki/blob/%{markus_version}/RESTful-API.md">MarkUs Wiki</a> for information on using the API.
help_html: The API key is used for authentication for the MarkUs API. See <a href="%{docs_url}/technical-guides/restful-api/">the MarkUs documentation website</a> for information on using the API.
reset: Reset API key
unavailable: Unavailable
not_found: 'No user can be found with the user name: %{user_names}'
Expand Down
2 changes: 2 additions & 0 deletions config/settings/development.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ logging:
autotest:
max_batch_size: 10

docs_url: http://localhost:4000

lti:
adapter_file: <%= "#{::Rails.root}/config/dummy_lti_config.rb" %>
domains: <%= %w[host.docker.internal] %>
Expand Down
2 changes: 2 additions & 0 deletions config/settings/production.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ logging:
autotest:
max_batch_size: 500

docs_url: https://markus-docs.teach.cs.toronto.edu

# The settings below are for an experimental feature that is not available
# in production yet. Please disregard for now.
lti:
Expand Down
2 changes: 2 additions & 0 deletions config/settings/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,7 @@ lti:
unpermitted_new_course_message: 'You are not permitted to create a new MarkUs course for %{course_name}. Please contact your system administrator.'
sync_schedule: "0 3 * * *"

docs_url: http://localhost:4000

file_storage:
default_root_path: <%= "#{::Rails.root}/data/#{::Rails.env}#{ENV['TEST_ENV_NUMBER']}/" %>
10 changes: 0 additions & 10 deletions doc/README_FOR_APP

This file was deleted.

1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
destination: /jekyll/site
cache_dir: /jekyll/cache

url: https://markus-docs.teach.cs.toronto.edu
title: MarkUs Docs
description: Documentation for MarkUs — a web-based tool for the submission and grading of student programming assignments.
theme: just-the-docs
Expand Down
2 changes: 2 additions & 0 deletions jest_env_setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ window.$ = window.jQuery = global.jQuery = global.$ = $;
import {I18n} from "i18n-js";
import translations from "translations.json";
window.I18n = new I18n(translations);

global.DOCS_URL = "http://localhost:4000";