Add custom logging documentation to advanced tutorial #40
Conversation
Covers overriding individual message type handlers and replacing the entire output routing logic via psake-config.ps1. https://claude.ai/code/session_0184Z4DLZ8Db72rkpca4kQwP
Explains how psake discovers and loads the config file, lists all available configuration properties, and links to the custom logging doc for output handler details. https://claude.ai/code/session_0184Z4DLZ8Db72rkpca4kQwP
✅ Deploy Preview for psake ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Moved from tutorial-basics to tutorial-advanced since this is an uncommon, advanced topic - Added note that most projects don't need a config file - Added "Partial Overrides" section explaining that missing properties keep their defaults - Fixed cross-reference links https://claude.ai/code/session_0184Z4DLZ8Db72rkpca4kQwP
The previous intro stated psake had no way to log errors to a file, which is no longer true with the outputHandlers feature. Updated to describe the default behavior and link to the custom logging doc. https://claude.ai/code/session_0184Z4DLZ8Db72rkpca4kQwP
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for psake's custom logging capabilities, enabling users to integrate their own logging systems with psake's build process. The documentation is well-structured and provides clear guidance on both fine-grained control of individual message types and complete replacement of the logging system.
Changes:
- Added
docs/tutorial-advanced/custom-logging.mdwith detailed instructions for overriding psake's output handlers - Added
docs/tutorial-advanced/psake-config.mddocumenting the psake configuration file structure and all available properties - Updated
docs/tutorial-advanced/logging-errors.mdto reference the new custom logging documentation and clarify the default error handling behavior - Updated
sidebars.tsto include both new documentation pages in the Advanced Techniques section
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| sidebars.ts | Added two new entries (custom-logging and psake-config) to the Advanced Techniques section of the guides sidebar |
| docs/tutorial-advanced/custom-logging.md | New documentation explaining how to override psake's output handlers, including examples for specific message types and full logging replacement |
| docs/tutorial-advanced/psake-config.md | New documentation describing the psake-config.ps1 file structure, all configuration properties, and practical examples for common scenarios |
| docs/tutorial-advanced/logging-errors.md | Updated to clarify default error logging behavior and reference the new custom logging documentation |
| @@ -0,0 +1,71 @@ | |||
| # Custom Logging | |||
There was a problem hiding this comment.
Missing frontmatter block. Based on codebase conventions, tutorial files should include frontmatter with at minimum a description field for SEO and documentation clarity. For example, similar files use:
---
description: "Brief description of the topic"
---This helps with search engine optimization and provides context when the page is shared.
| @@ -0,0 +1,89 @@ | |||
| # psake Configuration File | |||
There was a problem hiding this comment.
Missing frontmatter block. Based on codebase conventions, tutorial files should include frontmatter with at minimum a description field for SEO and documentation clarity. For example, similar files use:
---
description: "Brief description of the topic"
---This helps with search engine optimization and provides context when the page is shared.
tablackburn
left a comment
tablackburn
left a comment
There was a problem hiding this comment.
Looks good. Address the Copilot comments before merging though.
Summary
This PR adds comprehensive documentation for psake's custom logging capabilities, enabling users to integrate their own logging systems with psake's build process.
Changes
New documentation: Added
docs/tutorial-advanced/custom-logging.mdcovering:Updated navigation: Added the new custom logging page to the advanced tutorial section in
sidebars.tsImplementation Details
The documentation explains two levels of customization:
heading,default,debug,warning,error,success) via$config.outputHandlers$config.outputHandlerfor full control over message handlingEach approach is documented with clear examples showing how to implement common scenarios like file logging and message suppression.
https://claude.ai/code/session_0184Z4DLZ8Db72rkpca4kQwP