openedx / openedx/docs.openedx.org

Test Periodic Table Tool - documentation files may contains file name errors

Open
#870 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

educators
Dominant language
JavaScript
Stars
35
Forks
95
Avg merge
5d 15h
Merged PRs (30d)
3

Description

EDIT: Moving to the docs.openedx.org repo. These files have been moved into this repo but are untested.

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Periodic Table documentation and its downloadable zip file, then verify the HTTP link and the case mismatch between the HTML reference and the provided CSS filename. Confirm with maintainers which proposed resolution is acceptable; done means the documented tool works with matching files and a secure link, or the tool is removed from the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, html, javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.