Skip to content

📝 [#593] Add documentation for logging and log event types#605

Merged
stevenbal merged 2 commits intomasterfrom
feature/593-structlog-event-docs
May 22, 2025
Merged

📝 [#593] Add documentation for logging and log event types#605
stevenbal merged 2 commits intomasterfrom
feature/593-structlog-event-docs

Conversation

@stevenbal
Copy link
Collaborator

Fixes #593

Changes

  • Add documentation for logging and log event types

@@ -0,0 +1,11 @@
.. _manual_index:

Manual
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not 100% sure if manual is the correct section name for this logging info

Copy link
Contributor

Choose a reason for hiding this comment

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

looking at the docs of other projects it seems to be the best place for it.

@codecov-commenter
Copy link

codecov-commenter commented May 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.66%. Comparing base (6a56740) to head (2dca69a).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #605   +/-   ##
=======================================
  Coverage   94.66%   94.66%           
=======================================
  Files         148      148           
  Lines        5171     5171           
=======================================
  Hits         4895     4895           
  Misses        276      276           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@stevenbal stevenbal force-pushed the feature/593-structlog-event-docs branch from b9188c1 to 3dc0a45 Compare May 20, 2025 08:22
Copy link
Contributor

@danielmursa-dev danielmursa-dev left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@Floris272 Floris272 left a comment

Choose a reason for hiding this comment

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

some minor stuff

@@ -0,0 +1,11 @@
.. _manual_index:

Manual
Copy link
Contributor

Choose a reason for hiding this comment

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

looking at the docs of other projects it seems to be the best place for it.

@stevenbal stevenbal mentioned this pull request May 22, 2025
16 tasks
@stevenbal stevenbal force-pushed the feature/593-structlog-event-docs branch from 3dc0a45 to 2dca69a Compare May 22, 2025 12:01
@stevenbal stevenbal merged commit f795856 into master May 22, 2025
25 checks passed
@stevenbal stevenbal deleted the feature/593-structlog-event-docs branch May 22, 2025 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation for devops so they know which logs can be expected

4 participants