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.
- Install Devstack on your local system as described here.
- Complete steps through
vagrant up
. - In Git for Mac, clone the repository to the devstack directory. You are overwriting the edx-platform directory with the repository from github.
- Select your working branch and synch it.
- Continue with instructions to run devstack:
- If you have closed your connection, run
vagrant up
. - Run
vagrant ssh
, then runsudo su edxapp
.
- 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.
- In the build/html directory, open the file that you want to see in your browser.
- In Finder, locate the files that you want to edit, edit the text in a text editor, and save the file.
- Run
make html
again, and then refresh the browser page.
- If you have closed your connection, run
- In in your browser, open the page you want in Studio or the LMS.
- In Finder, locate the file that contains the text you want, edit the text in a text editor, and save the file.
- In your browser, refresh the page to see changes.
...