Page Comparison

There are times when we want to If you are making changes to UI strings or Help text in HTML templates, you can make edx-platform your working GIT directory in a running version of devstack our working GIT directory:

• To build the developers documentation, we must be running the LMS and Studio, so the documentation can successfully pull in docstrings from Python code.
• To edit UI strings in HTML templates and test immediately, we need to have the system running locally.

. When you make your changes you can verify them in your local devstack prior to making commits to the master branch of edx-platform.

1. Install Devstack on your local system as described here.
2. Complete steps through vagrant up.
3. In Git for Mac, clone the repository to the devstack directory. You are overwriting the edx-platform directory with the repository from github.
4. Select your working branch and synch it.
5. Continue with instructions to run devstack:
   1. If you have closed your connection, run vagrant up.
   2. Run vagrant ssh, then run sudo su edxapp.
   Edit documentation or UI text.
   1. To see and edit developer documentation:Switch to the directory that contains your documentation (for example, edx-platform/docs/en_us/developers or edx-platform/docs/en_us/platform_api), and then run make html.
   2. In the build/html directory, open the file that you want to see in your browser.
   3. In Finder, locate the files that you want to edit, edit the text in a text editor, and save the file.
   4. Run make html again, and then refresh the browser page.
6. To edit UI text:
   1. In in your browser, open the page you want in Studio or the LMS.
   2. In Finder, locate the file that contains the text you want, edit the text in a text editor, and save the file.
   3. In your browser, refresh the page to see changes.
7. Commit and synch changes in Git as you would otherwise.

...