Migrate instructor data to individual selectable pages #1786

jkachel · 2023-07-27T17:03:57Z

What are the relevant tickets?

Closes mitodl/hq#1543
#1773

Description (What does it do?)

Converts the current method of storing resource page instructor data (a stream block within the page marked Faculty Members) to a new method that uses individual pages for the instructors that can be linked to the resource page instead. Also contains some helper stuff to convert the data, so the existing data is not lost.

Instructor pages

These are new and are designed to be located underneath an Instructor index page in Wagtail. The configure_wagtail command has been updated to create this index page if it doesn't exist.

Otherwise, instructor pages are normal Wagtail CMS pages. Some notes on fields:

Title and Name are separate - in the case of duplicates, titles can be different to allow instructor pages to be more easily found in the CMS while the instructor's name remains the same. (This is especially important for the convert_faculty_to_pages command - see below.)
Name is what's used in the card on the page.
There is a new Title field, this is displayed as a <h4> if present in the card.
The short bio is analogous to the old description field.
The long bio is not used currently.

`convert_faculty_to_pages`

This is a helper command that will load the data that's in the Faculty Members field in existing course pages, creates new Instructor Page instances for them, and then links them to the course page. It does not operate on Program pages as we're not using them now.

An Instructor Page is created for the faculty member listings regardless of whether or not the instructor already exists in the system so we preserve whatever distinct imagery and copy is there from that particular page. The output of the command should tell you the title of the page that was created for the particular course page so you can find it later. These can be coalesced into a single instructor page at your leisure later.

As part of the conversion process, the Faculty Members section is cleared for the page it's processing so duplicate cards aren't shown.

If there isn't an index page, the command will make one.

Template changes

The product_page.html template is now set up to display the Meet your instructors section if there's linked Instructor Pages or old-style Faculty Members. Instructor pages will be displayed first.

Instructor Pages have an additional Title field that wasn't in the old Faculty Members section - this is displayed as an h4 under the name if there is one.

No other changes for the cards - they should look the same as they did before.

How can this be tested?

Create a course page with some faculty members in it.
Run convert_faculty_to_pages. This should convert the faculty member listings to pages, and apply them back to the course page.
View the course page. It should not be visibly different.
View the course page in the CMS. You should see the linked Instructor Pages and Faculty Members should be empty.
Explore the CMS - you should see an Instructors section with the new pages underneath. They should be Drafts.

- Finalizes instructor page models and link to product page - Adds support into the template for this (alongside the in-page faculty members section) - Started in on a migration to backfill instructor pages from existing faculty member sections; not done yet

…ing root page if it doesn't exist in convert management command

Otherwise converting with duplicates (which there are guaranteed to be) will result in people's cards having (3) (4), etc. appended to their names. (The titles don't get used int he card, just the name.)

…ch page

pdpinch · 2023-07-28T12:25:35Z

Does this work with the existing design, the upcoming redesign, or both?

How will we transition from the current system to the new one? What should I be telling the MITx folks who manage the about pages?

jkachel · 2023-07-28T14:20:38Z

Does this work with the existing design, the upcoming redesign, or both?

Both!

How will we transition from the current system to the new one? What should I be telling the MITx folks who manage the about pages?

There's a command to facilitate the migration process that will need to be run manually. The command scrapes the instructor data off the existing course pages, puts them into new instructor pages, links them to the course page it was working on, and then clears the Faculty Members section on the page; the end result is that the faculty members all get moved to instructor pages and there's no duplication of cards on the course pages.

The timeline for migration looks like this:

Until the command is run: everything works as it does normally, except there's a new section in the CMS. The template still displays the people in the Faculty Members section so there's no change to the learner, and the MITx folks can ignore the new section in the CMS.
When we perform the migration (immediately after running the command): All the data in each Faculty Members section will be translated into an Instructor Page. The command doesn't make any effort to dedupe this so there will likely be a bunch of similar pages (we can use the output from the command to determine which one goes to which page); it'd be best to clean that up some. But, immediately after running the migration command, the course about pages should look exactly as they did.
After the migration: I'll need to put up a new PR to eliminate the old Faculty Members section (and move the title for the section; it's out of order now), and they'll just create and link in instructor pages as necessary.

collinpreston

Looks good and works for me.

I noticed that a faculty page that is in "draft" status will still display if added to a Course about page.

I am also able to create an Instructor Page in the Courses "folder" in the CMS.

collinpreston · 2023-07-28T18:12:15Z

cms/api.py

@@ -212,6 +210,30 @@ def ensure_certificate_index() -> cms_models.CertificateIndexPage:
    return certificate_index


+def ensure_instructors_index() -> cms_models.InstructorIndexPage:
+    """
+    Ensures that an index page has been created for instructorns.


"instructorns" -> "instructors"

collinpreston · 2023-07-28T18:34:56Z

cms/management/commands/convert_faculty_to_pages.py

+        )
+
+        parser.add_argument(
+            "--live", action="store_true", help="Make the page live. (Defaults to not.)"


Defaults to draft or not live?

Made the flag and text more understandable (Wagtail calls it Draft/Published in the UI but the DB table calls it "live"). df1ea62 also adds some code to disallow serving of InstructorPages specifically - we don't want them exposed right now (but we might later and I repurposed other code for this so it's in there from that).

collinpreston · 2023-07-28T19:06:06Z

cms/models.py

@@ -472,6 +473,112 @@ def create_country_field(self, field, options):
        return ChoiceField(**options)


+class InstructorPage(Page):
+    """
+    Detail page for instructors.


I think you can add in something like:

mitxonline/cms/models.py

Line 1525 in e09ce6f

subpage_types = []

Which will not allow child pages to be created for an InstructorPage.

…(as a page)

collinpreston

Looks good to me!

collinpreston · 2023-07-31T14:07:16Z

cms/management/commands/convert_faculty_to_pages.py

+    InstructorIndexPage,
+    InstructorPage,
+    InstructorPageLink,
+    ProgramPage,


This import can be removed.

jkachel added 11 commits July 26, 2023 11:11

Adding instructor page models

aa36bea

changing slug for instructor page

661d4ae

something merged oddly for some reason

22f32ed

Added command to migrate faculty members to pages for reuse

e09ce6f

ran black

8006bf6

Update configure_wagtail to add instructors stuff, fix bug in generat…

7bd2b72

…ing root page if it doesn't exist in convert management command

fixing tests

635fe4e

Adds factories, updates context test for instructors

0fedb00

Updating to make the title != the name if there's a duplicate

e4c717c

Otherwise converting with duplicates (which there are guaranteed to be) will result in people's cards having (3) (4), etc. appended to their names. (The titles don't get used int he card, just the name.)

adding title to the output so you know which duplicate belongs to whi…

959eeca

…ch page

jkachel added Needs Review product:mitx-online labels Jul 27, 2023

jkachel mentioned this pull request Jul 27, 2023

Epic: Redesign course and program about pages #1773

Closed

16 tasks

collinpreston self-requested a review July 28, 2023 17:10

collinpreston suggested changes Jul 28, 2023

View reviewed changes

collinpreston added Waiting on Author and removed Needs Review labels Jul 28, 2023

Fix typo, fix --live flag, explicitly deny instructor page rendering …

df1ea62

…(as a page)

jkachel requested a review from collinpreston July 28, 2023 20:26

collinpreston approved these changes Jul 31, 2023

View reviewed changes

removing a couple unused imports

f4d85fe

jkachel merged commit 58659cb into main Jul 31, 2023
3 checks passed

jkachel deleted the jkachel/1773-instructor-pages branch July 31, 2023 14:22

odlbot mentioned this pull request Jul 31, 2023

Release 0.70.2 #1791

Merged

4 tasks

jkachel mentioned this pull request Aug 10, 2023

Currently displayed instructor bios should be the long ones #1811

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate instructor data to individual selectable pages #1786

Migrate instructor data to individual selectable pages #1786

jkachel commented Jul 27, 2023

pdpinch commented Jul 28, 2023

jkachel commented Jul 28, 2023 •

edited

Loading

collinpreston left a comment

collinpreston Jul 28, 2023

collinpreston Jul 28, 2023

jkachel Jul 28, 2023

collinpreston Jul 28, 2023

collinpreston left a comment

collinpreston Jul 31, 2023

Migrate instructor data to individual selectable pages #1786

Migrate instructor data to individual selectable pages #1786

Conversation

jkachel commented Jul 27, 2023

What are the relevant tickets?

Description (What does it do?)

Instructor pages

convert_faculty_to_pages

Template changes

How can this be tested?

pdpinch commented Jul 28, 2023

jkachel commented Jul 28, 2023 • edited Loading

collinpreston left a comment

Choose a reason for hiding this comment

collinpreston Jul 28, 2023

Choose a reason for hiding this comment

collinpreston Jul 28, 2023

Choose a reason for hiding this comment

jkachel Jul 28, 2023

Choose a reason for hiding this comment

collinpreston Jul 28, 2023

Choose a reason for hiding this comment

collinpreston left a comment

Choose a reason for hiding this comment

collinpreston Jul 31, 2023

Choose a reason for hiding this comment

`convert_faculty_to_pages`

jkachel commented Jul 28, 2023 •

edited

Loading