Skip to content

Conversation

colinmurphy
Copy link
Member

@colinmurphy colinmurphy commented Oct 7, 2025

Description

Note

This is the last PR before BETA release.

This pull request primarily updates documentation for the WPGraphQL Logging plugin and the toolkit installation guide. The main improvements include clearer installation instructions, a more concise and developer-focused plugin README, and the removal of outdated or redundant documentation files.

Installation & Usage Documentation Updates:

  • Added a new "Available Plugins" section and updated the example composer.json and installation instructions in docs/how-to/install-toolkit-plugins/index.md to include wpgraphql-debug-extensions and wpgraphql-logging plugins. [1] [2] [3]

WPGraphQL Logging Plugin Documentation Improvements:

  • Completely rewrote the README.md for wpgraphql-logging to provide a concise overview, highlight key features, clarify requirements, and streamline installation and developer documentation references. The new README replaces extensive details with links to dedicated documentation files and removes outdated sections.

Cleanup of Outdated Documentation:

  • Removed the obsolete docs/ConfigurationHelper.md and docs/Events.md files from the wpgraphql-logging plugin, as their content has been superseded by more focused documentation or is now covered elsewhere. [1] [2]

Related Issue

Fixes #365

Dependant PRs

Type of Change

  • ✅ Bug fix (non-breaking change which fixes an issue)
  • [] ✨ New feature (non-breaking change which adds functionality)
  • [] 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactoring (no functional changes)
  • 📄 Example update (no functional changes)
  • 📝 Documentation update
  • 🔍 Performance improvement
  • [] 🧪 Test update

How Has This Been Tested?

Screenshots

Checklist

  • I have read the CONTRIBUTING document
  • My code follows the project's coding standards
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • Any dependent changes have been highlighted, merged or published

Copy link

changeset-bot bot commented Oct 7, 2025

🦋 Changeset detected

Latest commit: f0f3e1b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@wpengine/wpgraphql-logging-wordpress-plugin Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

As some of the requests cannot detect correctly if the user is an admin. We removed this rule.
Copy link

github-actions bot commented Oct 7, 2025

📦 Plugin Artifacts Ready!

Download from GitHub Actions run

Available plugins:

  • ✅ wpgraphql-logging.zip

See the "Artifacts" section at the bottom of the Actions run page

Added three new how-to guides for extending WPGraphQL Logging admin: adding fields to existing tabs, creating new settings tabs, and adding columns to the logs grid. Updated index and reference docs to link and document these extension points. Added relevant screenshots for each guide.
Added new documentation for WPGraphQL Logging event pub/sub system and context injection (docs/how-to/events_pub_sub.md, docs/how-to/events_add_context.md), updated index and events reference docs to link and describe these features, and added a screenshot for context data. Removed unused .gitkeep from examples.
Added new how-to documentation for extending WPGraphQL Logging with custom Monolog handlers, processors, and rules. Updated index and reference docs to link to these guides and clarified terminology and navigation. Minor improvements to existing docs for accuracy and consistency.
@colinmurphy colinmurphy changed the title chore: DRAFT - WPGraphQL Logging Plugin Docs - BETA Release chore: WPGraphQL Logging Plugin Docs & Snag Updates Oct 9, 2025
@colinmurphy colinmurphy requested a review from theodesp October 9, 2025 16:15
@colinmurphy colinmurphy marked this pull request as ready for review October 9, 2025 16:15
@colinmurphy colinmurphy requested a review from a team as a code owner October 9, 2025 16:15
@colinmurphy colinmurphy enabled auto-merge October 9, 2025 16:17
Updated version from patch to minor for the plugin.
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.

WPGraphQL Logging - Snagging, QA, Documentation and Tests
1 participant