docs: Add instructions for testing logging.

[dianakhuang]

---

I've completed each of the following or determined they are not applicable:

• Made a plan to communicate any major developer interface changes (or N/A)

[Copilot]

Pull request overview

Adds documentation to help developers validate changes to the Docker logging configuration when working in devstack, where volume mounts can override image-baked configuration.

Changes:

• Introduces a new “Custom Logging Testing” section explaining devstack-specific constraints.
• Documents where to copy logging-related settings so they can be exercised in devstack.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (2)

docs/testing_and_debugging.rst:77

• The path shown for the devstack override file is not a real path in this repo (and (lms|cms) reads like a regex). Devstack uses py_configuration_files/lms.py and py_configuration_files/cms.py (see docker-compose-host.yml mounts), so this instruction is likely to mislead readers.

Any changes will need to be copied over into ``/py_configuration_files/{lms,cms}.py`` to be tested
on devstack.

docs/testing_and_debugging.rst:79

• This hyperlink target definition is malformed: :: starts a literal block, so the public-dockerfiles logging configuration reference will not resolve correctly. Use a standard reStructuredText link target (.. _name: URL).

:: _public-dockerfiles logging configuration: https://github.com/edx/public-dockerfiles/blob/75aa946f58b9d897ae1f738b2c89aefb1af09147/dockerfiles/edx-platform.Dockerfile#L262-L264

[Copilot]

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (2)

docs/testing_and_debugging.rst:79

• The RST hyperlink target definition is malformed (uses "::" instead of the standard ".. name: URL" syntax). As written, the public-dockerfiles logging configuration reference will not resolve and may break doc builds.

:: _public-dockerfiles logging configuration: https://github.com/edx/public-dockerfiles/blob/75aa946f58b9d897ae1f738b2c89aefb1af09147/dockerfiles/edx-platform.Dockerfile#L262-L264

docs/testing_and_debugging.rst:74

• "this file" is ambiguous here (it’s unclear whether it refers to the Dockerfile in public-dockerfiles or a generated logging config file). Clarifying the referent will make the instructions easier to follow.

If you would like to test modifications to the docker logging configuration as
listed in the custom-created `public-dockerfiles logging configuration`_, this
file won't exist in devstack due to the local edx-platform copy overriding it.

[Copilot]

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

docs/testing_and_debugging.rst:79

• This line is written as a literal-block introducer (::), so the hyperlink target for public-dockerfiles logging configuration won’t be defined and the earlier reference will render as a broken link. Use the standard reStructuredText hyperlink target directive (.. _name: URL) instead.

:: _public-dockerfiles logging configuration: https://github.com/edx/public-dockerfiles/blob/75aa946f58b9d897ae1f738b2c89aefb1af09147/dockerfiles/edx-platform.Dockerfile#L262-L264

[robrap]

Minor comment that you could add using github UI, as long as you change the commit subject to "fixup! ...". I only mention this because I think you said you tend not to use github for this.

[Copilot]

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

docs/testing_and_debugging.rst:79

• The external link target is written as a literal block ("::") instead of an RST hyperlink target. As a result, the public-dockerfiles logging configuration_ reference above will not resolve when building the docs.

.. _public-dockerfiles logging configuration: https://github.com/edx/public-dockerfiles/blob/75aa946f58b9d897ae1f738b2c89aefb1af09147/dockerfiles/edx-platform.Dockerfile#L262-L264

[Copilot]

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

docs/testing_and_debugging.rst:77

• The path to the settings overrides should be relative to the devstack checkout (consistent with other docs like docs/codejail.rst:27 and docker-compose-host.yml volume mounts). A leading "/" makes it look like an absolute filesystem path and will likely confuse readers.

Any changes will need to be copied over into ``/py_configuration_files/{lms,cms}.py`` to be
tested on devstack.