Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The good news is that creating sample data is not that difficult. It does require a little work in Github, but you do not need to write code. This page assumes that you are using Github via the web interface since that is generally the most user-friendly approach, but you can also use other pathways to manage repositories and commit files

Table of Contents

Step 1: Open a Jira

This will allow whatever dev team is maintaining mod-courses to manage the work they need to do. Open a ticket in the MODCR project in Jira and title it something like "Adding new sample data on reference environments."

...

For example, suppose you wanted to add a new term for Fall 2024. What This is how you would could do isit:

  1. Go to https://folio-snapshot.dev.folio.org and go to Settings > Courses > Terms.
  2. Open Developer Tools (see Intro to Developer Tools in Google Chrome for more help with developer tools.)
  3. Select the New button and create the term for Fall 2024. 
  4. When you save the term, in Developer Tools on the Network panel, you should see the API call that FOLIO sends to create the term
    Image RemovedImage Added
  5. In the Response tab tab, you'll see the JSON that was created when you added the term. This is the thing that you want to copy out and use in Github.
    Image Added
  6. Copy the term and in your forked copy of github, create a new file in the Terms folder called 'Term009.json' (or whatever the next number is in that folder.) Paste in the JSON from the term you just created, and save the file.

Step 4: Create a pull request with your new files

Once you've added all of the new sample data you want to add, you'll create a pull request back to the parent copy of mod-courses.

There are various ways to create a pull request, but the important thing is to make sure the title includes the Jira number from step 1. E.g., if you created a Jira and the number