WooCommerce App Marketplace page

components/woocommerce/README.md

@@ -9,3 +9,53 @@ WooCommerce is a customizable, open-source eCommerce platform built on WordPress
 - **Automated Order Confirmation Emails**: Use the WooCommerce API to monitor new orders and trigger personalized confirmation emails through a service like SendGrid. This workflow can include order details, expected delivery dates, and upsell opportunities.
 
 - **Customer Support Ticket Creation**: On receiving a new customer inquiry or support request via WooCommerce, instantly generate a ticket in a customer support platform like Zendesk. This ensures no customer query goes unnoticed and helps maintain high service standards.
+
+# Getting Started
+
+To connect your WooCommerce store to Pipedream, create a REST API key.
+
+## Creating a WooCommerce REST API Key
+
+Open the **WooCommerce** plugin in your WordPress admin dashboard and select the Advanced tab. Navigate to the **REST API** section and click **Create an API key**.
+
+![Creating an API key for WooCommerce from within your WordPress admin dashboard](https://res.cloudinary.com/pipedreamin/image/upload/v1715009382/marketplace/apps/woocommerce/CleanShot_2024-05-06_at_11.25.25_2x_tf9j1w.png)
+
+We recommend naming this API key "Pipedream" to easily remember its purpose. Select a user account that this API key should be tied to, ideally one with at least store manager access.
+
+Next, choose the level of permission you’d like Pipedream workflows to have. You can choose between:
+
+- **Read** - your Pipedream workflows can only read data, not update or insert new data.
+- **Write** - your Pipedream workflows can update or insert data like orders and products, but cannot read them.
+- **Read/Write** - your Pipedream workflows can both read and write data on your WooCommerce store.
+
+![Choose the user, name and the permissions level for your WooCommerce API key](https://res.cloudinary.com/pipedreamin/image/upload/v1715009382/marketplace/apps/woocommerce/CleanShot_2024-05-06_at_11.26.05_2x_rfyt9k.png)
+
+After generating the API key, you’ll receive a **Consumer Key** and **Consumer Secret**. Copy these values into Pipedream under the respective **Key** and **Secret** fields.
+
+Finally, enter your domain name. For example, for `https://example-store.com`, simply enter `example-store.com`. If your store is hosted on a subpath, like `https://my-site.com/store`, enter `my-site.com/store`.
+
+Double-check your store’s home URL under the **Settings area in WordPress.**
+
+# Troubleshooting
+
+## Unable to connect to the WooCommerce REST API
+
+### Check your Permalink structure
+
+![Make sure your WordPress store has the Post Name URL structure for Pipedream to be able to connect to it correctly.](https://res.cloudinary.com/pipedreamin/image/upload/v1715010321/marketplace/apps/woocommerce/CleanShot_2024-05-06_at_11.42.43_2x_qe3qu8.png)
+
+To enable Pipedream's access to your WooCommerce store’s REST API, ensure your WordPress site’s Permalink Structure is set to `Post name`. Open the **Settings** area in WordPress, navigate to the **Permalink** section, verify that the **Permalink** setting is set to `Post name`, and click **Save** to apply the change.
+
+### Check your WordPress Home URL
+
+If you still cannot connect your WooCommerce store to Pipedream, ensure that your site’s Home URL structure is not on a subdomain or subpath. You can find your WordPress site’s Site URL under the Settings > General section.
+
+If your site’s URL is `https://example.com`, then the Pipedream `domain` field for your WooCommerce connected account should be `example.com`. If your WordPress site’s home URL is under a different subdomain, such as `https://store.example.com`, then enter `store.example.com` for the `domain` field for your connected account.
+
+### Firewall issues
+
+By default, Pipedream Workflows originate from dynamic IP addresses within the `us-east-1` region in AWS. To allow Pipedream connections, set up a Pipedream VPC to assign a static IP address to your workflows.
+
+## Permissions issues
+
+Ensure the user associated with your WooCommerce API key has the necessary permissions to read or write specific resources like products or orders. Additionally, double-check that your API key has read and/or write permissions.

docs-v2/pages/components/guidelines.mdx

@@ -202,6 +202,8 @@ Here's an example `README.md` structure:
 
 # Overview
 
+# Example Use Cases
+
 # Getting Started
 
 # Troubleshooting
@@ -212,7 +214,7 @@ These sections will appear within the correponding app, source and action page,
 
 Here's an example of an [app `README.md` within the `discord` component on the Pipedream registry](https://github.com/PipedreamHQ/pipedream/blob/master/components/discord/README.md). That same content is rendered within the [Pipedream integration page for the Discord app](https://pipedream.com/apps/discord).
 
-You can add additional subheadings to each of the top level `Overview`, `Getting Started` and `Troubleshooting` headings:
+You can add additional subheadings to each of the top level `Overview`, `Example Use Cases`, `Getting Started` and `Troubleshooting` headings:
 
 ```markdown
 # Overview
@@ -221,6 +223,12 @@ You can add additional subheadings to each of the top level `Overview`, `Getting
 
 Perhaps there are some limitations about the API that users should know about.
 
+# Example Use Cases
+
+1. Sync data in real time
+2. Automate tedious actions
+3. Introduce A.I. into the workflow
+
 # Getting Started
 
 ## Generating an API key