Skip to content

Conversation

@mattnowzari
Copy link
Contributor

@mattnowzari mattnowzari commented Apr 24, 2025

Closes #282 & #278

This PR adds a one-line note to LOGGING.md that explains logging features are to be part of 0.3.0 and newer releases.

This PR also will add some extra details around Event logs - what they are, what information do they contain, when/how you'd use them, etc

Checklists

Pre-Review Checklist

  • This PR does NOT contain credentials of any kind, such as API keys or username/passwords (double check crawler.yml.example and elasticsearch.yml.example)
  • This PR has a meaningful title
  • This PR links to all relevant GitHub issues that it fixes or partially addresses
    • If there is no GitHub issue, please create it. Each PR should have a link to an issue
  • this PR has a thorough description
  • Added a label for each target release version (example: v0.1.0)
  • Considered corresponding documentation changes
  • Contributed any configuration settings changes to the configuration reference

@mattnowzari mattnowzari requested a review from a team as a code owner April 24, 2025 16:02
@mattnowzari mattnowzari changed the title Adding note about version support in LOGGING.md Improvements to LOGGING.md Apr 24, 2025
@mattnowzari
Copy link
Contributor Author

Thanks for the review Nav! The doc should be a lot cleaner now. Not quite sure where my head was at when I wrote it 🤣 I'll definitely proofread more next time

@mattnowzari mattnowzari merged commit 712026c into main Apr 28, 2025
2 checks passed
@mattnowzari mattnowzari deleted the update_logging_docs branch April 28, 2025 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Note in logging docs that logging features are not part of previous releases

3 participants