OERu course review process

From WikiEducator
Jump to: navigation, search

General guidelines

Recommended work flow

  1. Move the corresponding review card on oeru.kanboard.net to the "Work in progress" column.
  2. Focus on the review of a single card issue (eg links, copyright of images, layout) rather than attempting to review all issues simultaneously.
  3. When you have completed the review of a designated card for the respective micro-course, sign-off that you have completed the review by posting a comment on the respective review card on oeru.kanboard.net.
  4. Need help: Please post questions relating to any aspects of the course review instructions on chat.oeru.org

Review the published course on the course.oeru.org site

  1. The review must be conducted from the published course site on course.oeru.org
  2. At the bottom of each page of the published course site, you will find a "Content" link which links to the source page in the WikiEducator.
  3. Fix minor errors directly in the wiki, for example typos, minor layout fixes, fixing links etc. (Note: The revisions in the wiki will not update on the published site until the snapshot script is run again.)
  4. Record issues which must still be fixed by duplicating and posting a green "Issue card" on oeru.kanboard.net.

Image copyright audit

The OERu is committed to using free cultural works approved licenses. In short, this means that we only use CC-BY, CC-BY-SA or images dedicated to the public domain. The purpose of this audit is to:

  • confirm that all images used on the course site meet these requirements, and
  • review that image attributions have been properly recorded in WikiEducator (when you click on an image on the published course site, it will link to the image attribution page in WikiEducator).


  1. Visit every page on the course site and click on all images (suggest using opening the image in a new tab to keep your place on the course site.)
  2. Review the image attribution data and check the following:
    • Confirm that the license is CC-BY, CC-BY-SA, CC-0 or dedicated to the public domain.
    • Check the image source link and verify that the original license is correct (i.e. confirming that the individual who uploaded the image on the cited source applied the correct license).
    • Check that the source url links to the individual image and not the overall site url from which the images was sourced.
    • Apply reasonable judgement to confirm that the correct license was applied to the source image. Sometimes, for example, users upload stock images to Flickr which are all rights reserved and apply the wrong license.
    • Images which are sourced from the WikiMedia Commons need not be reviewed in detail because the WikiMedia community have robust review practices in place and their licensing policy is the same as OERu. Immediately below the image, but before the Summary of the metadata you will see this confirmation to confirm Wikimedia Commons images: This file is from Wikimedia Commons and may be used by other projects. (see for example this image of Jean Piaget which was sourced from the Commons.
  3. Google's reverse image search is useful tool to support the image audit when trying to remedy an incomplete source url in the wiki or validating the license. Click on "search by image" and using the full wiki url. To get the full image url on WikiEducator, from the metadata page, click on the image then copy the full url for the Google image search.
  4. Create an issue card on oeru.kanboard or any issues which must be resolved and remember to include the full url of the relevant page in WikiEducator or the course site where the image is used. The standard procedure where breach of copyright is identified is to delete the image and find an openly licensed alternative.

Link checks

The primary purpose of the hyperlink audit is to confirm that there are no broken links on the published course site and that all web links resolve to the intended target page.

  • Note: The OERu does not use the practice of targeting links to open in new window or tab as this breaks the how most users navigate the web (and the browser has a back button).


  1. Visit every page of the on the course site and click on all links to confirm that the link works and that the link goes to the intended target page (suggest opening the link in a new tab to keep your place on the course site.)
  2. Correct pages that use the incorrect convention of "Conduct a Google search here." The preferred convention is to hyperlink directly, for example, "Conduct a Google search."
  3. It is usually quicker to fix url links directly in WikiEducator by clicking on the "Content" link at the bottom of the page on the course site than the time required for recording an issue card on oeru.kanboard.org.
  4. In cases where you are unable to resolve the link issue, please duplicate an issue card on oeru.kanboard.net and describe the problem and include the full url of the page on the course site or WikiEducator where the problem was identified. In pages with many links, provide direction on where the problem link can be found. For example, "in the second paragraph under the "Overview" heading the link to ...."
  5. Once you have completed the link audit for the respective micro course and recorded an outstanding issues, please post a comment on the "Link review" card on oeru.kanboard.net that you have completed the task.

Audit of Next/Prev links

The purpose of the Next/Previous link check is to confirm that these buttons displayed near the bottom of the individual pages on the published course site which enable users to navigate sequentially between pages in the sequence are working.

The source of broken Next/Prev links may be caused by the use of restricted characters in the pipe text (link display text) of the corresponding wiki page syntax in the course outline (i.e. [[Wiki_page_name/sub_page_name|Pipe text or Display text]]). If the pipe text contains a restricted character like slashes "/" or duplicate of an identical pipe name used elsewhere in the outline, it will cause the Prev/Next link to break on the published site.


  1. Visit the published course site on course.oeru.org (Note: the homepage doesn't display a Next / Prev link button).
  2. Go to the "first" page of the respective OERu course. This can be accessed from the main site navigation link on the left and first sub-menu item. (This is usually the Startup -> Start here page for most OERu courses.)
  3. Click on the "Next" button at the bottom of each course page.
    • If you encounter a "page not found" error, use the back button to go to the previous page and note the name of the learning pathway, or main navigation section and page title.
    • Visit the course outline page in WikiEducator, go to the relevant section and the page immediately following the one you noted above.
    • Click on "Edit source" and edit the pipe text to remove the use of any restricted characters. (Note: The course website will not be updated until a new Snapshot is requested. We recommend that you complete the audit before requesting a new snapshot.
    • If you are unable to identify the cause of the "page not found" error, duplicate an issue card on oeru.kanboard and record the details as well as the section (or learning pathway) name of the page immediately preceding the page not found error including the full url.
  4. When the audit is completed, request a new snapshot from the respective staff member in your organisation who assembled the course outline.
  5. Confirm that you have completed the audit by posting a comment on the appropriate "Check Next/Previous links" card on the Kanboard.

Audit of transclusion links

The purpose of this audit is to check that the course authors have used transclusion for specified links. This provides greater flexibility for maintaining OERu courses.

The convention is to list all links used for transclusion on the main planning page or as a sub-page list. When viewing the source wiki text, transcluded links take the general form of [{{:Source_page/Transcluded_wiki_subpage}} Link display text]. In other words, you must click on the "Edit source" or "View source" links of the corresponding pages to confirm that the specified links are transcluded.

This review should be conducted by someone with intermediate wiki skills.


  1. Syllabus page: Check that the dates for each Session are transluded. Most courses prior to the launch date will use the following text for transclution: "for independent study" which will be replaced by the actual dates when the course goes live, for example "Saturday 6 to Tuesday 9 August 2016". Cross check the transclusion links on the main course planning page (or sub-page for transcluded links) to ensure that there transclusion has been implemented for each session "date" of a cohort base offering.
  2. Posting a WENote: The wiki syntax to invoke the WENotesPost widget should be transcluded on the respective course pages rather than entering the widget syntax directly on the page concerned. Here is an example of the transclusion page used for inserting a WENote post on the individual course pages of the Principles of management course. Here is an example showing the transclusion of a WENote post in the same course. Work through the course pages to ensure that each instance of a WEnote post is transcluded rather than entering the widget syntax directly on the course page.
  3. Course code: Each OERu micro-course has a unique course code which should be lowercase because it is also used for software code, for example: csf101, csf102, csf103 and csf104. The course code for each micro-course should be transcluded wherever it is used in the course. There are typically two use cases:
    • Course code embedded within a published page: Check each page of the course site where the course code is used by using the browser text search function. When you encounter the text string for the course code, click on "Edit source" to ensure that the course code is transluded rather than typed directly on the relevant course page.
    • Tag parameter for a widget or template: Where a tag parameter is required, it should use transclusion for example the WENotesPost widget or a template that requires a course code, for example, the resource bank template. See example of how the course code is transcluded for the tag parameter.
      1. Check that the syntax for posting a WENote is transcluded and uses a transclusion for the course tag parameter (see above).
      2. Scan the course for use of the the resource bank template by using the wiki's What links here feature to quickly identify pages using this template. Check that the course code paramater is transcluded in each instance.
  4. Forum links: Where learners are invited to post contributions to a discussion on forums.oeru.org, the page link directing the learner to the relevant forum topic should be transcluded. A separate transclusion source page is required for each forum activity. It is important to check that these links point to the relevant forum topic (identified by the topic number suffix in the url, for e.g. https://forums.oeru.org/t/ient101-market-research-questions/222) rather than the landing page for the course forum topics (e.g. https://forums.oeru.org/c/introduction-to-entrepreneurship, that is, without the topic number suffix in the url.)
    • Check the transclusion links for forum posts on the main planning page or as a sub-page list to ensure that they point to the specific forum. Go to the "What links here link" from the relevant transclusion source page and visit the pages using the transclusion link. Read the relevant forum instructions and follow the link to forums.oeru.org to ensure that it is pointing to the correct forum. Note that this check will not identify url links to forum activities entered directly on the course page that have not been transcluded.
    • Scan through the individual learning pathways to identify any links to forums.oeru.org which have not been transcluded by viewing the source wiki text.
  5. New participant survey: As part of the OERu process and product evaluation, we invite learners to complete this optional survey. This link must be transcluded. There are usually two pages where the link to the survey is used:
    • Start here page Check the "Start here" page to confirm that the new participant survey is transcluded and points to the correct survey link.
    • Instructions for getting ready: Most OERu courses include an announcement for "Session 0" or "Instructions for getting ready" in the announcements section of the course. Check that there is a link to the new participant survey and that this has been transcluded.