diff --git a/docs/release_notes/Makefile b/docs/release_notes/Makefile new file mode 100644 index 0000000000..d02280e2fd --- /dev/null +++ b/docs/release_notes/Makefile @@ -0,0 +1,183 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +Q_FLAG = + +ifeq ($(quiet), true) +Q_FLAG = -Q +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = $(Q_FLAG) -d $(BUILDDIR)/doctrees -c source $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/getting_started.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/getting_started.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/getting_started" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/getting_started" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/release_notes/__init__.py b/docs/release_notes/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/release_notes/source/10-29-2013.rst b/docs/release_notes/source/10-29-2013.rst new file mode 100644 index 0000000000..c833f6ae70 --- /dev/null +++ b/docs/release_notes/source/10-29-2013.rst @@ -0,0 +1,89 @@ +################################### +October 29, 2013 +################################### + +************* +edX Studio +************* + +============= +New Features +============= + +* **New video editing interface, enabling an enhanced workflow for adding timed transcripts to videos** (BLD-238) + + When you enter a video URL in the Editing: Video dialog box, the system checks if a timed transcript for that video exists on edX, and if + so, automatically associates the transcript with the video. If no transcript is found, you click Upload New Timed Transcript to locate and + upload the .SRT file for the transcript. + + When there is an associated timed transcript, you can click Download to Edit to download a local copy of the .SRT file. You can then + modify the transcript and upload the new file. + + For YouTube videos, you can also import a timed transcript from YouTube, overwriting the version of the transcript on edX with the version + from YouTube. + + Backwards compatibility with the other transcript workflow is maintained with a tabbed interface. + +==================================================== +Known Issues and Workarounds +==================================================== + +* **Uploading a large number of files** (STUD-813, STUD-837) + + When you go to the Files & Uploads page, if your course has a large number of files, the Files & Uploads page can time out before it lists + all the files. The page becomes unresponsive, and you cannot upload more files. + + **Workaround**: To upload new files files when the Files & Uploads page is timing out, limit the number of files that appear on the Files & + Uploads page by adding start and max parameters to the URL. For example, you can append the following parameters to the URL in your + browser: + `https://studio.edge.edx.org/assets/organization.course-number.course-name/branch/block/course-name?start=5&max=15` + + This example tells the page to load a maximum of 10 files, starting with the 6th file. You can use other values as needed, as long as the list + is not so long that the page does not load successfully. Note that file counts begin at 0, not 1, and that files are listed chronologically, with + the most recent first. + + + + + +========================== +Changes and Updates +========================== + +The following changes are included in this release: + +* Because Course IDs are not case sensitive, all Course IDs must be unique regardless of capitalization. For example, you cannot have + both edX101 and EdX101 as course IDs. (STUD-873) + + +*************************************** +edX Learning Management System +*************************************** + + +The following changes are included in this release: + +* The cheatsheet available when you are adding a new Wiki article is now accessible to screen readers. (LMS-1303) + +* In the Wiki, active links are now displayed as bold, and have additional text labels, to be accessible to screen readers. (LMS-1306) + +* In the Wiki, when you navigate through links with the Tab key, the active link is updated in the same was as when you hover over it with + the mouse pointer. (LMS-1336) + +* Default Wiki permissions are updated so that only course staff can delete Wiki pages. (LMS-1355) + +* The Reset Password and Password Reset Confirmation pages are updated to use styles consistent with the system. (LMS-1357) + +* In certain situations, students received a 500 error when viewing the Progress page. This problem was resolved in a patch on October 23, 2013. (LMS-1367) + +* A visual indicator has been added to the video player to indicate which part of the video will play, when it is not the default. (BLD-391) + +* Forum views are updated to improve performance. (FOR-250) + +****************** +Analytics +****************** + +The following changes are included in this release: + +* Course exports are included with weekly data dumps delivered to university data representatives. (AN-57) diff --git a/docs/release_notes/source/11-06-2013.rst b/docs/release_notes/source/11-06-2013.rst new file mode 100644 index 0000000000..11e9bbe31b --- /dev/null +++ b/docs/release_notes/source/11-06-2013.rst @@ -0,0 +1,112 @@ +################################### +November 6, 2013 +################################### + +************* +edX Studio +************* + +============= +New Features +============= + +* **Improved Course Export page** + + The Course Export page has a new layout, with enhanced help text. + +========================== +Changes and Updates +========================== + +The following changes are included in this release: + +* The Forgot Password link on the Studio Sign In page now works correctly. (STUD-689) + +* In the Create a New Course page Organization field, text now suggests the generic UniversityX, instead of MITx. (STUD-885) + +* The Create a New Course page Course Run field, text now suggests the using the year and trimester (for example, 2014_T1), instead + of the year and season. (STUD-916) + +* Studio now continues working correctly when a YouTube video in the page fails to load. (STUD-472) + +* To avoid potential problems with browser security, you can no longer enter video URLs with http://. You must use https://. (BLD-408) + +* By default, the options to add a Problem Written in LaTex and a Problem with Adaptive Hint in Latex are no longer included in the + Advanced tab of the Problems component. In addition, the option to add E-text Written in LaTeX is no longer included in the HTML component. + + To enable these options, open the Advanced Settings page and set the value of the use_latex_compiler policy key to true. (BLD-426) + +========================== +Technical Changes +========================== + +Contributors to the open source edX Platform should note the following change: + +The Course Export page is updated to use a RESTFul interface. (STUD-846) + +*************************************** +edX Learning Management System +*************************************** +========================== +New Features +========================== + +* **Upgrading the Course Track** + + A student in the Honor Code or Audit track can now upgrade to the Verified Certificate track. (LMS-1127) + +========================== +Changes and Updates +========================== + +The following changes are included in this release: + +* After registering for a course, a student could use the browser's Back button to return to the Registration page and change the + registration type. Now, if the user tries to go back to the Registration page, the Learning Management System redirects the student to the + courseware, where the student must unregister first to change the course mode. (LMS-1062) + +* When a student fails verification for the Verified track, the Learning Management System now notifies the user through the Student + Dashboard, and prompts them to retry. The student must send another set of photos, but does not have to pay again. If the student does + not retry, they can get a refund. (LMS-1133) + +* In the Beta Instructor Dashboard, the layout is improved and the Pending Instructor Tasks section now functions correctly. (LMS-1242) + +* You can now tab through the Wiki pages without getting stuck in the content area. (LMS-1307) + +* Default settings now include the generic email address @example.com instead of @edx.org. (LMS-1363) + +* The user experience and help text during course registration and upgrading are enhanced, and the last day to register for verified certificates is more clear. (LMS-1384) + +* Keyboard navigation is now updated in the Wiki to skip repetitive content, allowing users to go directly to unique content on a page. (LMS-1387) + +* Errors that prevented the Progress page from successfully loading are fixed. (LMS-1388) + +* In the Sign Up page, the Public Display Name field was renamed to Public Username. (LMS-1393) + +* Errors when creating a new account are resolved. (LMS-1418) + +* A typo was removed from the course registration email template. (LMS-1419) + +* The Saving a Word Cloud component generated an error message. This problem no longer occurs. (BLD-205) + +* When viewing a video, if a student clicked on the video timeline before or after the specified end time, the video jumped to the beginning. This problem is resolved. (BLD-392) + +* Students can now change the video speed when the video is paused. (BLD-424) + +* Several problems with the video player are resolved: + * The Start time did not work in Flash mode. + * Students could not change the speed before the video started. + * The end point in the video slider was inaccurate for short videos. + * The video slider showed the incorrect position after the video stopped. (BLD-468) + +* Sorting of the forums thread list now works correctly when a topic is selected from the drop-down menu. (FOR-224) + +* Forum follow buttons are now accessible to screen readers, have the ARIA checkbox role, and activate with the space or Enter key.(FOR-240) + +****************** +Analytics +****************** + +The following changes are included in this release: + +* The user_id field is added to tracking events. (AN-213) diff --git a/docs/release_notes/source/12-03-2013.rst b/docs/release_notes/source/12-03-2013.rst new file mode 100644 index 0000000000..fa3dd07522 --- /dev/null +++ b/docs/release_notes/source/12-03-2013.rst @@ -0,0 +1,56 @@ +################################### +December 3, 2013 +################################### + +************* +edX Studio +************* + + +The following Studio changes are included in this release: + +* As part of a database architecture change and the implementation of a RESTful interface, URLs in Studio are changing to use a new + period-separated locator syntax. This change currently affects a subset of pages in Studio. In future releases, the other pages in Studio + will be changed to use the new URL syntax. + +* Video transcripts now load correctly even if any part of https is in capital letters. (BLD-496) + +* The Problem component now includes a template for creating checkbox problems. (BLD-193) + +* In Internet Explorer 9, Save notifications now appear correctly when a user locks or unlocks assets. (STUD-815) + + + +******************************* +edX Learning Management System +******************************* + + + +The following changes are included in this release: + +* Discrepancies in how the number of enrolled students were calculated in the Instructor Dashboard and the Beta Instructor Dashboard are + fixed. Now, in all cases, the number represents the currently enrolled students. (AN-115) + +* Incorrect student responses to problems are now saved after the student clicks Check. (LMS-469) + +* JavaScript errors are now fixed in the Reset Password pages. (LMS-1265) + The Wiki Changes page is now accessible to screen readers. (LMS-1309) + +* Course staff can now set granular permissions for Wiki articles. In the main Wiki page, you can click Settings to see and set + permissions. (LMS-1355) + +* In the Instructor Dashboard, the Edit Course in Studio link now correctly opens the course in Studio. (LMS-1455) + +* Taking a photograph for a verified certificate now works correctly. (LMS-1487) + +* Links within videos no longer have a white background or obscure part of the video content. (BLD-521) + +* In checkbox problems, using bold and italics no longer causes display problems. (BLD-449) + +* The speed change option now works correctly in all video configurations. (BLD-457) + +* A spinning icon now shows users with slow connections when a video is loading. (BLD-502) + +* In the Forums, an AJAX request that results in a 500 error now informs the user to try again, instead of silently timing out. (FOR-37) + diff --git a/docs/release_notes/source/conf.py b/docs/release_notes/source/conf.py new file mode 100644 index 0000000000..62753762c4 --- /dev/null +++ b/docs/release_notes/source/conf.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# + +import sys, os + +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +sys.path.append(os.path.abspath('../../../')) +sys.path.append(os.path.abspath('../../')) + +from docs.shared.conf import * + +sys.path.insert(0, os.path.abspath('.')) + +master_doc = 'index' + +# Add any paths that contain templates here, relative to this directory. +templates_path.append('source/_templates') + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path.append('source/_static') + + +# General information about the project. +project = u'Release Notes for edX Course Staff' +copyright = u'2013, edX Documentation Team' + +# The short X.Y version. +version = '' +# The full version, including alpha/beta/rc tags. +release = '' \ No newline at end of file diff --git a/docs/release_notes/source/index.rst b/docs/release_notes/source/index.rst new file mode 100755 index 0000000000..3f1ffcc896 --- /dev/null +++ b/docs/release_notes/source/index.rst @@ -0,0 +1,23 @@ +.. Getting_Started documentation master file, created by + sphinx-quickstart on Tue Apr 16 11:19:12 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + + +Contents +======== + +.. toctree:: + :numbered: + :maxdepth: 5 + + read_me + 12-03-2013 + 11-06-2013 + 10-29-2013 + + + + + + diff --git a/docs/release_notes/source/latex/Makefile b/docs/release_notes/source/latex/Makefile new file mode 100644 index 0000000000..6b87ad8814 --- /dev/null +++ b/docs/release_notes/source/latex/Makefile @@ -0,0 +1,66 @@ +# Makefile for Sphinx LaTeX output + +ALLDOCS = $(basename $(wildcard *.tex)) +ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) +ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) + +# Prefix for archive names +ARCHIVEPRREFIX = +# Additional LaTeX options +LATEXOPTS = + +all: $(ALLPDF) +all-pdf: $(ALLPDF) +all-dvi: $(ALLDVI) +all-ps: all-dvi + for f in *.dvi; do dvips $$f; done + +all-pdf-ja: + for f in *.pdf *.png *.gif *.jpg *.jpeg; do extractbb $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + -for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.dvi; do dvipdfmx $$f; done + +zip: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +tar: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +bz2: tar + bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar + +# The number of LaTeX runs is quite conservative, but I don't expect it +# to get run often, so the little extra time won't hurt. +%.dvi: %.tex + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + +%.pdf: %.tex + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + +clean: + rm -f *.dvi *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla + +.PHONY: all all-pdf all-dvi all-ps clean +.PHONY: all-pdf-ja + diff --git a/docs/release_notes/source/read_me.rst b/docs/release_notes/source/read_me.rst new file mode 100644 index 0000000000..b414160d13 --- /dev/null +++ b/docs/release_notes/source/read_me.rst @@ -0,0 +1,18 @@ +******* +Read Me +******* + +The edX *Building a course with Studio* documentation is created +using RST_ files and Sphinx_. You, the user community, can help update and revise +this documentation project on GitHub:: + + https://github.com/edx/edx-platform/tree/master/docs/course_authors/source + +To suggest a revision, fork the project, make changes in your fork, and submit +a pull request back to the original project: this is known as the `GitHub Flow`_. +All pull requests need approval from edX. For more information, contact edX at docs@edx.org. + +.. _Sphinx: http://sphinx-doc.org/ +.. _LaTeX: http://www.latex-project.org/ +.. _`GitHub Flow`: https://github.com/blog/1557-github-flow-in-the-browser +.. _RST: http://docutils.sourceforge.net/rst.html \ No newline at end of file