Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Docs: add database queries log documentation #5301

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

dilipbheda
Copy link

Fixes #5299

Description

I've updated the debugging.md file to include the env variables for enabling database queries.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow [best practices][best_practices].
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

@dilipbheda dilipbheda requested a review from a team as a code owner December 25, 2024 09:50
@dilipbheda dilipbheda requested review from krysal and dhruvkb and removed request for a team December 25, 2024 09:50
@openverse-bot openverse-bot added 🧱 stack: documentation Related to Sphinx documentation 🟩 priority: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 📄 aspect: text Concerns the textual material in the repository 🧱 stack: api Related to the Django API labels Dec 25, 2024
Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution @dilipbheda! I have a suggestion that will hopefully make the documentation clearer 😄

documentation/api/guides/debugging.md Outdated Show resolved Hide resolved
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: api Related to the Django API 🧱 stack: documentation Related to Sphinx documentation
Projects
Status: 🔁 Changes Requested
Development

Successfully merging this pull request may close these issues.

Add instructions for debug database logging in the API to the docs
3 participants