Things that seem good:
...
- code.edx.org does not point to issue tracking. It would be great to have a section explaining what is expected from reporters, explaining that they HAVE to sign in and pointing to
- Add "use screen" instructions or equivalent 'cause it takes about an hour to run the installation script
- Guide to debugging: not able to connect to CMS
...
- there is no documentation on how to split the different services on multiple servers
- there is no documentation on how to enable HTTPS without using an SSL termination server
- https://github.com/edx/configuration/wiki/edX-Production-Stack is an empty page
- depending on the path from code.edx.org I choose, I will be presented different installation's options
- http://edx.readthedocs.org/projects/edx-installing-configuring-and-running/en/latest/ : that seems old and may be deprecated
- https://github.com/edx/configuration/wiki#installation-options : that page says that there are 4 options available, 1 of them is the Production Stack which is the empty page
- https://github.com/edx/edx-platform#installation : 3 available options on this one but 1 of them is the broken Production Stack :/
- it may be useful to move the manual installation process from https://github.com/edx/configuration/wiki/edX-Ubuntu-12.04-64-bit-Installation cause there is some very useful information at the end of the page which seems to be part of the manual process. Maybe moving things is not the right answer, but we definitely need to make the last bit of information more easy to see
The page has not been updated for Aspen.
Installation (Dev stack):
- when running the vagrant up for the devstack, the freetype error (which is documented so that's good) is not easy to spot. Indeed, it's written with the rest of the ansible output, in green (at least in my terminal setup). There are 2 parts that are printed in red so the first one seems to be the error but in reality, it's not an issue (at least it seems it's not) and one must really read the green stuff to see a its very end a message about freetype.
- apparently the thread that further explains the MONGO auth temporary fix is no longer available or not properly linked. ( https://github.com/edx/configuration/wiki/edX-Developer-Stack)
- the troubleshooting section in the github wiki, it´s really usefull. I would recommend to add some more links to it around because you might just miss it.
- some additional troubleshooting tips may be required in relation to ruby ant the bundle install process.
Random Stuff:
- In JIRA, there are issues which are links like "Original Issue (XZY-123)", which once clicked on go to a page asking for a log-in. The existing credentials used to create the account on JIRA does not work.
...
- the first link in the read me section for the OLX has an outdated link pointing to https://github.com/edx/edx-platform/docs/en_us/olx/source it should probably point to https://github.com/edx/edx-documentation/tree/master/en_us/olx/source
- In the http://edx-open-learning-xml.readthedocs.org/en/latest/about/short-description.html page
it says : You create an HTML file called short_description.html in the overview directory.
it should say: You create an HTML file called short_description.html in the about directory.
- in http://edx-open-learning-xml.readthedocs.org/en/latest/pages/pages.html#course-tabs is not clear enough that apart from writing html files for each new tab for the course, you have to edit the policy.json file to register your new tabs and also add in there something like:
,
"xml_attributes": {
"filename": [
"course/2014.xml",
"course/2014.xml"
] - there are a few missing example images in http://edx-open-learning-xml.readthedocs.org/en/latest/problem-xml/multiple_choice.html
Overall comments:
- There are a number of similar tools being used in different places (github wiki, confluence wiki)
...