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

Improve docs related to LMS/CMS testing #1234

Open
@robrap

Description

@robrap
Contributor

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?

Activity

moved this to Prioritized in Arch-BOMon Dec 4, 2023
moved this from Prioritized to Groomed in Arch-BOMon Dec 11, 2023
moved this from Groomed to Prioritized in Arch-BOMon Mar 8, 2024
moved this from Prioritized to Backlog in Arch-BOMon Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @robrap

        Issue actions

          Improve docs related to LMS/CMS testing · Issue #1234 · openedx-unsupported/devstack