Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Restructure documentation #233

Merged
merged 4 commits into from
Jan 6, 2024
Merged

Restructure documentation #233

merged 4 commits into from
Jan 6, 2024

Conversation

xepozz
Copy link
Member

@xepozz xepozz commented Jan 6, 2024

Q A
Is bugfix?
New feature?
Breaks BC?
Fixed issues #135

@xepozz xepozz requested a review from a team January 6, 2024 12:18
@xepozz xepozz added the status:code review The pull request needs review. label Jan 6, 2024
Copy link

what-the-diff bot commented Jan 6, 2024

PR Summary

  • Expanded Documentation
    Several new sections were added to our documentation to help users better understand and implement certain features. This includes specific guidance on ways to implement collectors and summary collectors, command instructions for debug:events and debug:reset, as well as directions on handling service collector and controlling logging. Moreover, tips on filtering requests and console commands were also provided.

  • New Logging Information
    A new file named logging.md was included in the docs/en directory. This document gives detailed instructions on how to configure and designate the storage driver for logging purposes.

  • Enhanced Readability in Debug Commands
    In both DebugContainerCommand.php and DebugEventsCommand.php, modifications were made in the table column headers, changing "Group" to "Groups". This will improve readability and help users understand the information in these sections better.

  • Documentation Index Page
    For improved navigation, an index page has been added to the documentation, allowing users to locate and access specific sections with ease.

Copy link

codecov bot commented Jan 6, 2024

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (8b0585a) 85.36% compared to head (266360b) 84.75%.

❗ Current head 266360b differs from pull request most recent head ec5d699. Consider uploading reports for the commit ec5d699 to get more accurate results

Files Patch % Lines
src/Command/DebugContainerCommand.php 0.00% 1 Missing ⚠️
src/Command/DebugEventsCommand.php 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##             master     #233      +/-   ##
============================================
- Coverage     85.36%   84.75%   -0.61%     
  Complexity      585      585              
============================================
  Files            40       40              
  Lines          1804     1804              
============================================
- Hits           1540     1529      -11     
- Misses          264      275      +11     

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

docs/en/collector.md Outdated Show resolved Hide resolved
docs/en/collector.md Outdated Show resolved Hide resolved
docs/en/collector.md Outdated Show resolved Hide resolved
docs/en/collector.md Outdated Show resolved Hide resolved
docs/en/collector.md Outdated Show resolved Hide resolved
docs/en/command-container.md Outdated Show resolved Hide resolved
docs/en/command-events.md Outdated Show resolved Hide resolved
docs/en/command-events.md Show resolved Hide resolved
docs/en/command-reset.md Outdated Show resolved Hide resolved
docs/en/filtering.md Outdated Show resolved Hide resolved
Co-authored-by: Alexander Makarov <[email protected]>
docs/en/collector.md Outdated Show resolved Hide resolved
docs/en/collector.md Outdated Show resolved Hide resolved
@xepozz xepozz merged commit 5b1263c into master Jan 6, 2024
14 of 15 checks passed
@xepozz xepozz deleted the docs branch January 6, 2024 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:code review The pull request needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants