Skip to content
This repository has been archived by the owner on Aug 1, 2024. It is now read-only.

Improve docs related to LMS/CMS testing #1234

Open
2 tasks
robrap opened this issue Dec 1, 2023 · 0 comments
Open
2 tasks

Improve docs related to LMS/CMS testing #1234

robrap opened this issue Dec 1, 2023 · 0 comments

Comments

@robrap
Copy link
Contributor

robrap commented Dec 1, 2023

A/C

Original ticket:

  1. It isn't clear from these docs that a browser container is needed when running the JS tests. It would be useful to mention to note that.
  2. The link to the edx-platform testing doc is broken. It should point to readthedocs version here: https://docs.openedx.org/projects/edx-platform/en/latest/concepts/testing/testing.html
  3. Related to the above, the edx-platform docs already includes notes about devstack, and requiring the browser container here: https://docs.openedx.org/projects/edx-platform/en/latest/concepts/testing/testing.html#running-javascript-unit-tests
  4. The list of commands in the devstack doc is outdated, since we don't have bokchoy (and a11y?) tests. Can we remove most of this redundancy and just point to the edx-platform testing doc instead?

Other related notes:

  1. The ./in hack is probably more globally useful (maybe?)? Could this be described elsewhere more generally, and maybe just linked to here? I didn't know this script existed.
  2. Should make lms-shell be updated to make dev.shell.lms? Do we have a preferred standard, or do we want the docs to use assorted versions of our commands?
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant