Learn for Jira Server and DC

Course Editor

Learn for Jira administrators can delete courses, upload custom courses, and reinstall the default courses.

Navigate to the Course Editor page to access these settings by clicking on the Learn Lighthouse icon at the top-right of Jira and then selecting Course Editor.

You are only able to reach this page if you have a full license for Learn for Jira and you are logged in with an account that has Jira administration permissions.

On the Content Management page, all of the courses currently in Learn for Jira are displayed and you can create content (upload or create a course), edit an existing course, or download a course, if you wish.

When you update Learn for Jira, any native courses that you have made changes to will be overwritten with the original course. We will soon be making these courses read-only. When we do this we will also provide an easier way for you to clone a course and hide visibility on the original course.

Create content

To create or upload a course to Learn for Jira, click the Create Content button in the banner.

Image highlighting the Create Content Button in the banner.

From there you have two options: to Create Course or to Upload Course.

Create course

The easiest way to create a customized course is by using the Learn for Jira editor.

To start creating a course, click Create Content > Create Course > Create from the Content Management page.

You then need to fill in information for this course:

  1. First enter a new Name for your course. Be descriptive but concise.

Learn for Jira lets you repeat course names. Think carefully before you decide to do this, as it may be confusing for your users.
  1. Next, enter a Description. This is optional, but encouraged, especially if you have several courses with similar names.

  2. Version is another optional plain-text field that you can use for a number, or to give more alpha-numeric information.

  3. Duration, of course, is how long you would expect a user to need to complete the course. You can change this field later if needed, so don’t worry if you put in a guesstimate.

  4. If you add a group to Course Visibility, you are restricting access to the course for that group only. You can add multiple groups to this field. When this field is left blank, all users who can interact with Learn for Jira can see the course.

  5. If you add a group to Course Edit Permission, you are restricting the ability to edit the course to the users in that group with course editing permission. You can add multiple groups to this field. When this field is left blank, any user who has course editing permission can edit the course.

  6. When you are finished, click Create.

Example image with fields filled in

When you are creating a course you are taken directly to your first chapter page. From here you can do several important things: Edit your chapter details, add modules to your chapter, and add more chapters. You can also go back and edit the course information if you need.

Edit chapter details

This one is a little tricky. On your first chapter and when you add a new chapter you need to go in and edit your chapter details. (If you don’t, all your chapters will be called "New Chapter.")

To edit your chapter details, click the ellipses menu by the chapter number on the chapter tab, then click Edit.

Image showing the ellipses menu dropdown options.

On the Edit Chapter page, enter a Name for your chapter. Then fill out the rest of the fields as desired. Even if you don’t want to write a description, delete the prompt text in the Description field box. When you are ready, click Update and you are taken back to the course page.

Add modules

On each chapter tab, you need to add the modules you want that chapter to cover.

Currently, you can only add modules that already exist in Learn for Jira, but in upcoming releases you will be given the ability to add your own modules.

To add a module, start typing in the box. This search requires full words, so you need to type complete words. By way of example, "perm" won’t return any modules, but "permission" will. The search looks at both a module’s title and its description, even though you cannot see the description in the results.

You can add as many chapters with as many modules as you like.

Because modules are shared between courses, progress on a particular module is tracked for all courses that module is in. It would therefore be possible to have never started a course but be finished with a portion of it already.

All changes are saved as you make them, so when you are happy with the content of your course, click Close. You can then view your new course at the bottom of the Course Viewer page.

Upload course

To upload a course, click Create Content > Upload Course > Create from the Content Management page.

A file dialogue box appears. Make your selection and click Open. You are returned to the Content Management page, and if you refresh the page you can see your new course added to the bottom of the page.

Courses must be JSON files with a specific set of attributes. You can download an existing course through the course’s edit screen and use that course JSON as an example for creating your own custom JSON courses.

Each course has a unique contentId. If you upload a course with the same contentId as a course that is already in Learn for Jira, the course you are uploading will overwrite the course that is already there, without any sort of warning alerts.

Download a course

If you want to add a course to a different instance of Jira or make a backup copy before deleting a course, you need to download it. From the Course Editor page, click Download to the right of a course’s title.

Download link to the right of a course description

This downloads a JSON file with the existing course’s information, which you can then edit and/or upload on the Jira instance you wish.

Customize a downloaded course

While it is easier to edit a course within Learn for Jira, you can also edit it in the downloaded JSON form. You can edit a JSON file to change the course, chapter, and module names, descriptions, URLs, and durations.

We recommend that you use an editor like IntelliJ, Atom, or Visual Studio Code.

Once you are done editing the file, save it locally and then upload it to Learn for Jira on the Jira instance you want.

If you have left the contentId for the course the same, it overwrites on any existing course of the same name.

If you have a unique course contentId, the upload creates a new course.

Delete a course

You can remove a course from Learn for Jira by clicking the Delete button at the bottom of it’s Edit Course page. This page is accessed by from the Content Management page by clicking Edit next to the course name to edit the course, and then clicking Edit again in the upper right corner.

When you click the Delete button you are required to enter the name of the course you are deleting as a safety precaution. Do not worry, though. If you have two courses with the same name, you will only be deleting the course that you are editing when you click Delete.

There is currently no way to restore a Learn for Jira course that you’ve deleted. Be sure to download a course’s JSON file before deleting it.