Date: Fri, 29 Mar 2024 14:52:58 +0000 (UTC) Message-ID: <230450081.17.1711723978860@4e8f765cc893> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_16_512144849.1711723978860" ------=_Part_16_512144849.1711723978860 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Audience: Course teams
Owner: Documentation team
Building and Running an edX Course helps course authors cr= eate course content quickly and easily. The documentation team updates this= guide as new features are released.
The process for creating or updating documentation in this guide is the = process outlined on the = Creating and Updating Documentation - RTD page.
The feature sets for edX partners and Open edX users are slightly differ= ent. Additionally, some Open edX sites use the most recent named release, w= hile others keep up with the edX master version. We use shared files and co= nditional text to produce three different versions of Building a= nd Running an edX Course.
Files for these guides are located in the following folders.
Guide Name | Source Files |
---|---|
Building and Running an edX Course | edx-documentation/en-us/course_authors |
Building and Running an Open edX Course | edx-documentation/en-us/open_edx_course_authors<= /td> |
Building and Running an Open edX Course: Eucalyp= tus Release | edx-documentation/en-us/ |
As of November 2016, any partner course author informati= on that also pertains to the Open edX course authors guide will be included= in the Open edX guide, but any information that pertains exclusively to th= e Open edX course authors guide will not be included unless the doc team re= ceives a request to include it and has the time to create documentation.
Some features are identified as requiring complete documentation well be= fore release, either for a contractual obligation or to assure support of a= pilot. The doc team prepares documentation in these cases to as high a sta= ndard of quality as possible. The resulting documentation is published priv= ately, meaning that an edX employee must send the URL to those that need it= , and labeled "DRAFT". This type of documentation is expensive to produce a= nd maintain, and delivery in this way should be a very infrequent exception= made only when there is high value to the edX organization.
For more information about creating draft projects, see Publish Documentation on Read the Docs.= p>