Skip to content

Commit cfe3b6a

Browse files
colinmurphycolinmurphy
committed
Added empty missing doc files for logging. Updated relative path for routes.
1 parent aeddd7f commit cfe3b6a

File tree

6 files changed

+172
-53
lines changed

6 files changed

+172
-53
lines changed

‎docs/nav.json‎

Lines changed: 75 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,120 @@
11
[
22
{
33
"title": "Introduction",
4-
"route": "/toolkit/"
4+
"route": "/headless-wordpress-toolkit/"
55
},
66
{
7-
"title": "Explanation",
8-
"route": "/toolkit/explanation/",
7+
"title": "WPGraphQL Logging Plugin",
8+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/",
99
"children": [
1010
{
11-
"title": "GET vs POST",
12-
"route": "/toolkit/explanation/get-vs-post/"
13-
},
14-
{
15-
"title": "GraphQL Endpoints",
16-
"route": "/toolkit/explanation/graphql-endpoints/"
11+
"title": "Tutorial",
12+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/tutorial/learn-logging/"
1713
},
1814
{
19-
"title": "Headless Authentication",
20-
"route": "/toolkit/explanation/headless-authentication/"
21-
},
22-
{
23-
"title": "Rendering Options",
24-
"route": "/toolkit/explanation/rendering-options/"
25-
},
26-
{
27-
"title": "Routing",
28-
"route": "/toolkit/explanation/routing/"
29-
},
30-
{
31-
"title": "Sitemaps",
32-
"route": "/toolkit/explanation/sitemaps/"
33-
}
34-
]
35-
},
36-
{
37-
"title": "How-To Guides",
38-
"route": "/toolkit/how-to/",
39-
"children": [
40-
{
41-
"title": "Install Toolkit Plugins via Composer",
42-
"route": "/toolkit/how-to/install-toolkit-plugins/"
15+
"title": "Explanation",
16+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/explanation/",
17+
"children": [
18+
{
19+
"title": "Event Architecture",
20+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/explanation/event-architecture/"
21+
},
22+
{
23+
"title": "Processors & Handlers",
24+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/explanation/processors-handlers/"
25+
},
26+
{
27+
"title": "Rule Manager",
28+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/explanation/rule-manager/"
29+
}
30+
]
4331
},
44-
{
45-
"title": "Automatic Persisted Queries in Next.js",
46-
"route": "/toolkit/how-to/nextjs-pages-router/enable-apq/"
47-
}
48-
]
49-
},
50-
{
51-
"title": "WPGraphQL Logging Plugin",
52-
"route": "/toolkit/plugins/wpgraphql-logging/",
53-
"children": [
5432
{
5533
"title": "How to Guides",
56-
"route": "/toolkit/plugins/wpgraphql-logging/how-to/",
34+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/how-to/",
5735
"children": [
5836
{
5937
"title": "Add a new Handler",
60-
"route": "/toolkit/plugins/wpgraphql-logging/how-to/logger-add-handler/"
38+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/how-to/logger-add-handler/"
6139
},
6240
{
6341
"title": "Add a new Processor",
64-
"route": "/toolkit/plugins/wpgraphql-logging/how-to/logger-add-processor/"
42+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/how-to/logger-add-processor/"
6543
},
6644
{
6745
"title": "Add or Remove a Rule",
68-
"route": "/toolkit/plugins/wpgraphql-logging/how-to/logger-add-remove-rules/"
46+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/how-to/logger-add-remove-rules/"
6947
},
7048
{
7149
"title": "Update the Log Store Service",
72-
"route": "/toolkit/plugins/wpgraphql-logging/how-to/update-log-store-service/"
50+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/how-to/update-log-store-service/"
7351
},
7452
{
7553
"title": "Use the Events Pub/Sub System",
76-
"route": "/toolkit/plugins/wpgraphql-logging/how-to/event-pub-sub/"
54+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/how-to/event-pub-sub/"
7755
},
7856
{
7957
"title": "Add Data to an Event",
80-
"route": "/toolkit/plugins/wpgraphql-logging/how-to/event-add-context/"
58+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/how-to/event-add-context/"
8159
},
8260
{
8361
"title": "Add a new Settings Field",
84-
"route": "/toolkit/plugins/wpgraphql-logging/how-to/admin-add-fields/"
62+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/how-to/admin-add-fields/"
8563
},
8664
{
8765
"title": "Add a new Settings Tab",
88-
"route": "/toolkit/plugins/wpgraphql-logging/how-to/admin-add-new-tab/"
66+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/how-to/admin-add-new-tab/"
8967
},
9068
{
9169
"title": "Update the Admin Grid",
92-
"route": "/toolkit/plugins/wpgraphql-logging/how-to/admin-add-view-column/"
70+
"route": "/headless-wordpress-toolkit/plugins/wpgraphql-logging/how-to/admin-add-view-column/"
9371
}
9472
]
9573
}
9674
]
75+
},
76+
{
77+
"title": "Explanation",
78+
"route": "/headless-wordpress-toolkit/explanation/",
79+
"children": [
80+
{
81+
"title": "GET vs POST",
82+
"route": "/headless-wordpress-toolkit/explanation/get-vs-post/"
83+
},
84+
{
85+
"title": "GraphQL Endpoints",
86+
"route": "/headless-wordpress-toolkit/explanation/graphql-endpoints/"
87+
},
88+
{
89+
"title": "Headless Authentication",
90+
"route": "/headless-wordpress-toolkit/explanation/headless-authentication/"
91+
},
92+
{
93+
"title": "Rendering Options",
94+
"route": "/headless-wordpress-toolkit/explanation/rendering-options/"
95+
},
96+
{
97+
"title": "Routing",
98+
"route": "/headless-wordpress-toolkit/explanation/routing/"
99+
},
100+
{
101+
"title": "Sitemaps",
102+
"route": "/headless-wordpress-toolkit/explanation/sitemaps/"
103+
}
104+
]
105+
},
106+
{
107+
"title": "How-To Guides",
108+
"route": "/headless-wordpress-toolkit/how-to/",
109+
"children": [
110+
{
111+
"title": "Install Toolkit Plugins via Composer",
112+
"route": "/headless-wordpress-toolkit/how-to/install-toolkit-plugins/"
113+
},
114+
{
115+
"title": "Automatic Persisted Queries in Next.js",
116+
"route": "/headless-wordpress-toolkit/how-to/nextjs-pages-router/enable-apq/"
117+
}
118+
]
97119
}
98120
]

‎docs/plugins/wpgraphql-logging/explanation/event-architecture/index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Explanation: Event Architecture"
3+
description: "Understanding the Event Architecture system in WPGraphQL Logging Plugin and how events are published and subscribed to throughout the logging process."
4+
---
5+
6+
@TODO

‎docs/plugins/wpgraphql-logging/explanation/index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Explanation"
3+
description: "Deep dive explanations of the WPGraphQL Logging Plugin's core concepts, architecture, and systems."
4+
---
5+
6+
@TODO

‎docs/plugins/wpgraphql-logging/explanation/processors-handlers/index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Explanation: Processors & Handlers"
3+
description: "Understanding the Processors and Handlers system in WPGraphQL Logging Plugin and how they process and store log data."
4+
---
5+
6+
@TODO

‎docs/plugins/wpgraphql-logging/explanation/rule-manager/index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Explanation: Rule Manager"
3+
description: "Understanding the Rule Manager system in WPGraphQL Logging Plugin and how it controls which GraphQL queries get logged."
4+
---
5+
6+
@TODO

‎docs/plugins/wpgraphql-logging/tutorial/learn-logging/index.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: "Tutorial Learn WPGRaphQL Logging Plugin"
3+
description: "Learn how to install and configure the WPGraphQL Logging Plugin, then customize it using its extensible architecture."
4+
---
5+
6+
@TODO
7+
8+
## Introduction
9+
10+
This tutorial will guide you through the core features of the WPGraphQL Logging Plugin. You will install and set up the plugin, and then you will see log data appear instantly.
11+
12+
Next, we will extend the plugin by:
13+
14+
- Subscribing to an event to add more context data
15+
- Displaying this new data on the admin grid
16+
- Adding a rule to the list of rules for the rule manager
17+
- Writing data to a new file handler
18+
19+
20+
By the end of this tutorial, you will be able to navigate and configure the plugin, and you will have the confidence to extend its functionality to suit your specific needs.
21+
22+
### Prerequisites
23+
24+
In order to complete this tutorial, you should:
25+
26+
- Be familiar with WordPress, WPGraphQL & PHP
27+
- Be familiar with installing a plugin for WordPress
28+
- Be comfortable to be able to add PHP code to a custom plugin
29+
30+
Before you get started you need the following
31+
32+
33+
## Setup
34+
35+
36+
### 1. Install the Plugin
37+
38+
### 2. Setup the configuration
39+
40+
41+
## Logging & Viewing Data
42+
43+
- Using WPGraphQL IDE
44+
- Logging a query
45+
- Show the user
46+
47+
48+
## Extending and adding data to the logs
49+
50+
### Event
51+
52+
### Admin Grid
53+
54+
55+
### Add Configuration
56+
57+
### Rule Manager
58+
59+
60+
### Updating the handler
61+
62+
63+
64+
## Conclusion
65+
66+
67+
68+
69+
70+
71+
## Contributing
72+
73+
We welcome and appreciate contributions from the community. If you'd like to help improve this documentation, please check out our [Contributing Guide](https://github.com/wpengine/hwptoolkit/blob/main/CONTRIBUTING.md) for more details on how to get started.

0 commit comments

Comments
 (0)