Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Lint markdown

This commit is contained in:
Manos Psychogyiopoulos 2023-10-02 11:20:46 +03:00
parent 24385808a4
commit 8c613aebaa
1 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
plugins/woocommerce/src/Admin/RemoteInboxNotifications/README.md
View File

@ -8,18 +8,18 @@ During the fetching of the specifications, each specification and the rules with
Following is the structure of the JSON feed, including the different rules that can be used to build up an inbox notification specification. Following is the structure of the JSON feed, including the different rules that can be used to build up an inbox notification specification.
## JSON file: ## JSON file
``` ```json
[ [
<spec>, <spec>,
... ...
] ]
``` ```
## Spec: ## Spec
``` ```json
{ {
"slug": "ad-for-automate-woo-2020-04-20", "slug": "ad-for-automate-woo-2020-04-20",
"type": "info", "type": "info",
@ -72,7 +72,7 @@ There are other note statuses but we just use them **internally**:
The note locales contain the title and content of the note. Having this broken up by locale allows different translations of the note to be used. The default locale used if none of the locales match the WordPress locale is `en_US`. The note locales contain the title and content of the note. Having this broken up by locale allows different translations of the note to be used. The default locale used if none of the locales match the WordPress locale is `en_US`.
``` ```json
{ {
"locale": "en_US", "locale": "en_US",
"title": "Ad for Automate Woo", "title": "Ad for Automate Woo",
@ -94,7 +94,7 @@ The note locales contain the title and content of the note. Having this broken u
These are the actions that can be interacted with on the note. This might be a link to a blog post, or an internal link to an admin page. These are the actions that can be interacted with on the note. This might be a link to a blog post, or an internal link to an admin page.
``` ```json
{ {
"name": "install-automate-woo", "name": "install-automate-woo",
"locales": [ "locales": [
@ -127,7 +127,7 @@ The `status` is what the status of the created note will be set to after interac
#### ActionLocale #### ActionLocale
``` ```json
{ {
"locale": "en_US", "locale": "en_US",
"label": "Install" "label": "Install"
@ -189,7 +189,7 @@ This passes if all of the listed plugins are installed and activated.
`plugins` is required. `plugins` is required.
``` ```json
{ {
"type": "plugins_activated", "type": "plugins_activated",
"plugins": [ "plugins": [
@ -207,7 +207,7 @@ Note that using both `publish_after_time` and `publish_before_time` allows timeb
`publish_after` is required. `publish_after` is required.
``` ```json
{ {
"type": "publish_after_time", "type": "publish_after_time",
"publish_after": "2020-04-22 00:00:00" "publish_after": "2020-04-22 00:00:00"
@ -222,7 +222,7 @@ Note that using both `publish_after_time` and `publish_before_time` allows timeb
`publish_before` is required. `publish_before` is required.
``` ```json
{ {
"type": "publish_before_time", "type": "publish_before_time",
"publish_before": "2020-04-22 00:00:00" "publish_before": "2020-04-22 00:00:00"
@ -235,7 +235,7 @@ This negates the rules in the provided set of rules. Note that the rules in `ope
`operand` is required. `operand` is required.
``` ```json
{ {
"type": "not", "type": "not",
"operand": [ "operand": [
@ -251,7 +251,7 @@ This performs an OR operation on the operands, passing if any of the operands ev
`operands` is required. `operands` is required.
``` ```json
{ {
"type": "or", "type": "or",
"operands": [ "operands": [
@ -269,7 +269,7 @@ This performs an OR operation on the operands, passing if any of the operands ev
Alternatively: Alternatively:
``` ```json
{ {
"type": "or", "type": "or",
"operands": [ "operands": [
@ -283,7 +283,7 @@ Alternatively:
This just returns a false value. This is useful if you want to keep a specification around, but don't want it displayed. This just returns a false value. This is useful if you want to keep a specification around, but don't want it displayed.
``` ```json
{ {
"type": "fail" "type": "fail"
} }
@ -297,7 +297,7 @@ This compares the installed version of the plugin to the required version, using
This example passes if Jetpack 8.4.1 is installed and activated. This example passes if Jetpack 8.4.1 is installed and activated.
``` ```json
{ {
"type": "plugin_version", "type": "plugin_version",
"plugin": "jetpack", "plugin": "jetpack",
@ -312,7 +312,7 @@ This allows access to a stored state containing calculated values that otherwise
This example passes if the `there_were_no_products` index is equal to `true`. This example passes if the `there_were_no_products` index is equal to `true`.
``` ```json
{ {
"type": "stored_state", "type": "stored_state",
"index": "there_were_no_products", "index": "there_were_no_products",
@ -325,7 +325,7 @@ There are only a limited amount of indices available to this rule, and new indic
The currently available indices are: The currently available indices are:
``` ```json
there_were_no_products there_were_no_products
there_are_now_products there_are_now_products
new_product_count new_product_count
@ -339,7 +339,7 @@ This passes if the number of products currently in the system match the comparis
This example passes if there are more than 10 products currently in the system. This example passes if there are more than 10 products currently in the system.
``` ```json
{ {
"type": "product_count", "type": "product_count",
"operation": ">", "operation": ">",
@ -355,7 +355,7 @@ This passes if the number of orders currently in the system match the comparison
This example passes if there are more than 10 orders currently in the system. This example passes if there are more than 10 orders currently in the system.
``` ```json
{ {
"type": "order_count", "type": "order_count",
"operation": ">", "operation": ">",
@ -373,7 +373,7 @@ This is used as a proxy indicator of the age of the shop.
This example passes if it has been active for more than 8 days. This example passes if it has been active for more than 8 days.
``` ```json
{ {
"type": "wcadmin_active_for", "type": "wcadmin_active_for",
"operation": ">", "operation": ">",
@ -387,7 +387,7 @@ This example passes if it has been active for more than 8 days.
This allows access to the onboarding profile that was built up in the onboarding wizard. The below example passes when the current revenue selected was "none". This allows access to the onboarding profile that was built up in the onboarding wizard. The below example passes when the current revenue selected was "none".
``` ```json
{ {
"type": "onboarding_profile", "type": "onboarding_profile",
"index": "revenue", "index": "revenue",
@ -402,7 +402,7 @@ This allows access to the onboarding profile that was built up in the onboarding
This passes when the store is on a WordPress.com site with the eCommerce plan. This passes when the store is on a WordPress.com site with the eCommerce plan.
``` ```json
{ {
"type": "is_ecommerce", "type": "is_ecommerce",
"value": true "value": true
@ -416,7 +416,7 @@ This passes when the store is on a WordPress.com site with the eCommerce plan.
This passes when the store is on a WordPress.com site with a Woo Express plan active. This passes when the store is on a WordPress.com site with a Woo Express plan active.
You can optionally pass the `plan` name to target a specific Woo Express plan, e.g. `performance`. You can optionally pass the `plan` name to target a specific Woo Express plan, e.g. `performance`.
``` ```json
{ {
"type": "is_ecommerce", "type": "is_ecommerce",
"plan": "trial|essential|performance" "plan": "trial|essential|performance"
@ -431,7 +431,7 @@ You can optionally pass the `plan` name to target a specific Woo Express plan, e
This passes when the store is located in the specified country. This passes when the store is located in the specified country.
``` ```json
{ {
"type": "base_location_country", "type": "base_location_country",
"value": "US", "value": "US",
@ -445,7 +445,7 @@ This passes when the store is located in the specified country.
This passes when the store is located in the specified state. This passes when the store is located in the specified state.
``` ```json
{ {
"type": "base_location_state", "type": "base_location_state",
"value": "TX", "value": "TX",
@ -461,7 +461,7 @@ This passes when the status of the specified note matches the specified status.
The below example passes when the `wc-admin-mobile-app` note has not been The below example passes when the `wc-admin-mobile-app` note has not been
actioned. actioned.
``` ```json
{ {
"type": "note_status", "type": "note_status",
"note_name": "wc-admin-mobile-app", "note_name": "wc-admin-mobile-app",
@ -477,7 +477,7 @@ compared to the provided value pass the operation test.
`timeframe` can be one of `last_week`, `last_month`, `last_quarter`, `last_6_months`, `last_year` `timeframe` can be one of `last_week`, `last_month`, `last_quarter`, `last_6_months`, `last_year`
``` ```json
{ {
"type": "total_payments_value", "type": "total_payments_value",
"timeframe": "last_month", "timeframe": "last_month",
@ -492,7 +492,7 @@ compared to the provided value pass the operation test.
This passes when the option value matches the value using the operation. This passes when the option value matches the value using the operation.
``` ```json
{ {
"type": "option", "type": "option",
"option_name": "woocommerce_currency", "option_name": "woocommerce_currency",
@ -510,7 +510,7 @@ This transforms the given option value into a different value by a series of tra
Example option value: Example option value:
``` ```php
Array Array
( (
[setup_client] => [setup_client] =>
@ -531,7 +531,7 @@ Array
If you want to ensure that the industry array contains `fashion-apparel-accessories`, you can use the following Option definition with transformers. If you want to ensure that the industry array contains `fashion-apparel-accessories`, you can use the following Option definition with transformers.
``` ```json
{ {
"type": "option", "type": "option",
"transformers": [ "transformers": [
@ -570,7 +570,7 @@ on update. Note that this doesn't provide a way to check the version number as
the `plugin_version` rule can be used to check for a specific version of the the `plugin_version` rule can be used to check for a specific version of the
WooCommerce Admin plugin. WooCommerce Admin plugin.
``` ```json
{ {
type: "wca_updated" type: "wca_updated"
} }