EdX Documentation and Resources

edX 101: A breakdown of edX.org, how users navigate, and more

Coupons: Contains all edX coupon code training documentation.

Degree About Pages: Step by step guide out building out a degree about page

Flex Pages: Step by step guide out building out a flex page

GDPR Workflow: Includes documentation for the GDPR implementation throughout edX.

Hubspot: Documentation focused on Customer Relationship Management function, automation and systems that handle processes or regulate/update data.

Institution Pages: How to update an existing record in Disco and a training walkthrough

Jira Process: The page houses all content on MOPS Jira process as it pertains to website requests, coupon codes, sunsets, and more.

Product Retirement/Sunset: A summary of documentation on retiring/sunsetting a program on edX.

Merchandising: An update to date summary of the current merchandising process. This process is continually changing.

There are 4 main CMS’s used to produce content on edX.org.

  • Contentful: This is used to create, manage and publish content on edX.org.
  • Compose: An app within Contentful that can be used to create pages. Compose has a better UI experience than Contentful, so it is preferred to use for certain pages.
  • Disco/Discovery: Manages all the content on edX.org, in a database style format
  • Hubspot: Manages a subsection of the content on edX.org, these pages can be edited and have the content published immediately.

Web pages in Contentful are often composed of many nested referenced entities. In the Contentful web app, this requires a lot of navigation between entries. With Compose, we combine these entries into a single editing interface, which allows users to edit and publish all the building blocks of a web page in one place.

Previewing a Page

  • If a program has previously been integrated, even without a landing page on edX, the card within the catalog will redirect to an external page. In order to view the page in that case, we need to push the page live. Thus breaking the redirect and not allowing for the ability to preview
  • For new catalog objects, we’re expecting internal pages by default so no redirects are set up. Thus we can preview the page, under secure preview, before pushing live.

Deployment/Build Schedule

  • Builds are kicked off by edX’s engineering team, and are subject to change or be delayed for multiple reasons on any given day. For the most up-to-date statuses on builds, you can find automatic updates in the #project-website-deploy Slack channel.
  • edX Build Time is a daily build: 9:30am ET, estimated finished building 9:45pm ET

Accessing Secure Preview

Which Page Type can be created in each CMS

Certain pages across edX use specific CMS’s to publish content.

Contentful CMS:

  • Degree Detail Pages (Degree About Pages)
  • Flex Pages

Compose CMS:

  • Degree Detail Pages (Degree About Pages)
  • Flex Pages

Disco CMS:

  • About Pages (Executive Education)
  • About Pages (OC Program)
  • Institution Pages
  • Schools & Partners Pages

HubSpot CMS:

  • Blog
  • Corporate Blog
  • mooc.org
  • Paid Landing Page

Reusing an existing UUID

In order to use a UUID from an existing, live page, we first need to:

  • Unpublish live page
  • Remove UUID from that page
  • Add UUID to new page
  • Publish new page

Note: Removing the UUID from the first page is necessary. Even if the original page is unpublished, the new page will not accept the UUID until it is completely removed from the original page.