Skip to content

Commit 52254ce

Browse files
westonruterwestonruter
committed
Move README.md to docs/introduction.md without mirrored content
1 parent 15ddaab commit 52254ce

File tree

5 files changed

+21
-66
lines changed

5 files changed

+21
-66
lines changed

‎plugins/optimization-detective/docs/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Optimization Detective Documentation
2+
3+
Please refer to the [WordPress.org Plugin Directory listing](https://wordpress.org/plugins/optimization-detective/) for the plugin description, installation instructions, frequently asked questions, and the [support forum](https://wordpress.org/support/plugin/optimization-detective/).
4+
5+
* [Introduction](./introduction.md)
6+
* [Extensions](./extensions.md)
7+
* [Hooks](./hooks.md)

‎plugins/optimization-detective/docs/extensions.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[Optimization Detective Documentation](./README.md):
2+
13
# Optimization Detective Extensions
24

35
The Optimization Detective plugin is a designed as a dependency for other plugins to extend to implement actual optimizations. Here you can find use cases and examples for how Optimization Detective is extended as well as a list of available extensions.

‎plugins/optimization-detective/docs/hooks.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[Optimization Detective Documentation](./README.md):
2+
13
# Optimization Detective Hooks
24

35
## Actions

‎plugins/optimization-detective/README.md ‎plugins/optimization-detective/docs/introduction.md

+2-60
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,6 @@
1-
# [Optimization Detective](https://wordpress.org/plugins/optimization-detective/)
1+
[Optimization Detective Documentation](./README.md):
22

3-
![Performance Lab plugin banner with icon](https://github.com/WordPress/performance/assets/10103365/99d37ba5-27e3-47ea-8ab8-48de75ee69bf)
4-
5-
Provides an API for leveraging real user metrics to detect optimizations to apply on the frontend to improve page performance.
6-
7-
## Description
8-
9-
This plugin captures real user metrics about what elements are displayed on the page across a variety of device form factors (e.g. desktop, tablet, and phone) in order to apply loading optimizations which are not possible with WordPress’s current server-side heuristics.
10-
11-
This plugin is a dependency which does not provide end-user functionality on its own. For that, please install the dependent plugin [Image Prioritizer](https://wordpress.org/plugins/image-prioritizer/) or [Embed Optimizer](https://wordpress.org/plugins/embed-optimizer/) (among [others](https://github.com/WordPress/performance/labels/%5BPlugin%5D%20Optimization%20Detective) to come from the WordPress Core Performance team). There are currently **no settings** and no user interface for this plugin since it is designed to work without any configuration.
12-
13-
Your site must have the **REST API accessible** to unauthenticated frontend visitors since this is how metrics are collected about how a page should be optimized.
3+
# Optimization Detective Introduction
144

155
## Background
166

@@ -34,51 +24,3 @@ URL Metrics have a “freshness TTL” after which they will be stale and the Ja
3424
👉 **Note:** This plugin optimizes pages for actual visitors, and it depends on visitors to optimize pages (since URL Metrics need to be collected). As such, you won't see optimizations applied immediately after activating the plugin (and dependent plugin(s)). And since administrator users are not normal visitors typically, optimizations are not applied for admins by default (but this can be overridden with the `od_can_optimize_response` filter below). URL Metrics are not collected for administrators because it is likely that additional elements will be present on the page which are not also shown to non-administrators, meaning the URL Metrics could not reliably be reused between them.
3525

3626
When the `WP_DEBUG` constant is enabled, additional logging for Optimization Detective is added to the browser console.
37-
38-
## Extensions, Use Cases, and Examples
39-
40-
See [extensions documentation](./docs/extensions.md).
41-
42-
## Hooks
43-
44-
See [hooks documentation](./docs/hooks.md).
45-
46-
## Installation
47-
48-
### Installation from within WordPress
49-
50-
1. Visit **Plugins > Add New** in the WordPress Admin.
51-
2. Search for **Optimization Detective**.
52-
3. Install and activate the **Optimization Detective** plugin.
53-
54-
### Manual installation
55-
56-
1. Download the plugin [ZIP from WordPress.org](https://downloads.wordpress.org/plugin/optimization-detective.zip) or, after following the [Getting Started instructions](https://make.wordpress.org/performance/handbook/performance-lab/), create a ZIP build from this repo via `npm run build:plugin:optimization-detective --env zip=true`.
57-
2. Visit **Plugins > Add New Plugin** in the WordPress Admin.
58-
3. Click **Upload Plugin**
59-
4. Select the `optimization-detective.zip` file on your system from step 1 and click **Install Now**.
60-
5. Click the **Active Plugin** button.
61-
62-
## Feedback
63-
64-
Feedback is encouraged and much appreciated, especially since this plugin may contain future WordPress core features. If you have suggestions or requests for new features, you can [submit them as an issue in the WordPress Performance Team's GitHub repository](https://github.com/WordPress/performance/issues/new/choose).
65-
66-
## Support
67-
68-
If you need help with troubleshooting or have a question about the plugin, please [create a new topic on our support forum](https://wordpress.org/support/plugin/optimization-detective/#new-topic-0).
69-
70-
## Contributing
71-
72-
Contributions are always welcome! Learn more about how to get involved in the [Core Performance Team Handbook](https://make.wordpress.org/performance/handbook/get-involved/).
73-
74-
The [plugin source code](https://github.com/WordPress/performance/tree/trunk/plugins/optimization-detective) is located in the [WordPress/performance](https://github.com/WordPress/performance) repo on GitHub.
75-
76-
## Security
77-
78-
The Performance team and WordPress community take security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
79-
80-
To report a security issue, please visit the [WordPress HackerOne](https://hackerone.com/wordpress) program.
81-
82-
## Changelog
83-
84-
Please see the [WordPress.org directory listing](https://wordpress.org/plugins/optimization-detective/) for the [changelog](https://wordpress.org/plugins/optimization-detective/#developers).

‎plugins/optimization-detective/readme.txt

+8-6
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,23 @@ This plugin is a dependency which does not provide end-user functionality on its
1717

1818
Your site must have the **REST API accessible** to frontend visitors since this is how metrics are collected about how a page should be optimized.
1919

20-
Please refer to the [full plugin documentation](https://github.com/WordPress/performance/blob/trunk/plugins/optimization-detective/README.md) for background information, the technical foundation, [filter/action hooks](https://github.com/WordPress/performance/blob/trunk/plugins/optimization-detective/docs/hooks.md), and [extensions](https://github.com/WordPress/performance/blob/trunk/plugins/optimization-detective/docs/extensions.md) that show use cases and examples.
20+
Please refer to the [full plugin documentation](https://github.com/WordPress/performance/blob/trunk/plugins/optimization-detective/docs/README.md) for a [technical introduction](https://github.com/WordPress/performance/blob/trunk/plugins/optimization-detective/docs/introduction.md), [filter/action hooks](https://github.com/WordPress/performance/blob/trunk/plugins/optimization-detective/docs/hooks.md), and [extensions](https://github.com/WordPress/performance/blob/trunk/plugins/optimization-detective/docs/extensions.md) that show use cases and examples.
2121

2222
== Installation ==
2323

24-
= Installation from within WordPress =
24+
= Installation from the directory within WordPress =
2525

26-
1. Visit **Plugins > Add New**.
26+
1. Visit **Plugins > Add New** in the WordPress Admin.
2727
2. Search for **Optimization Detective**.
2828
3. Install and activate the **Optimization Detective** plugin.
2929

3030
= Manual installation =
3131

32-
1. Upload the entire `optimization-detective` folder to the `/wp-content/plugins/` directory.
33-
2. Visit **Plugins**.
34-
3. Activate the **Optimization Detective** plugin.
32+
1. Download the plugin [ZIP from WordPress.org](https://downloads.wordpress.org/plugin/optimization-detective.zip) or, after following the [Getting Started instructions](https://make.wordpress.org/performance/handbook/performance-lab/), create a ZIP build from a clone of the [GitHub repo](https://github.com/WordPress/performance) via `npm run build:plugin:optimization-detective --env zip=true`.
33+
2. Visit **Plugins > Add New Plugin** in the WordPress Admin.
34+
3. Click **Upload Plugin**
35+
4. Select the `optimization-detective.zip` file on your system from step 1 and click **Install Now**.
36+
5. Click the **Active Plugin** button.
3537

3638
== Frequently Asked Questions ==
3739

0 commit comments

Comments
 (0)