search

openedx / edx-documentation

http://docs.edx.org
Other
161 stars 333 forks source link

Periodic Table Tool documentation links to files.edx.org, which contains file name errors #2188

Open MHaton opened 9 months ago

MHaton commented 9 months ago

This is not solely a documentation issue, but it affects the documentation, and we were unable to come up with a better place to log this issue.

The documentation for the Periodic Table Tool instructs users to download a file from files.edx.org. The link to this is http, rather than https.

The file in question is a zip file containing 4 files: image

The HTML in this file checks Files & Uploads for the two CSS and one JS file in the download, but it checks for periodic-table-colors.css and the file is named Periodic-Table-Colors.css - it's case sensitive.

This means that the tool does not actually function by following the documentation, because the files provided are named incorrectly.

Proposed solutions:

  1. Remove the periodic table tool from the documentation. It's not really a feature anyway.
  2. Update the files and host them somewhere else so that they can be maintained (such as this repository?)
  3. Someone on the edX.org end fixes the files and reuploads them