Merge pull request #10 from lucidworks/PE-728-PE-729-playgrounds-docs

Getting the e commerce app ready.

eLearning/playground-e-commerce/README.md

@@ -6,102 +6,69 @@ permalink: /playground-e-commerce/
 
 <link rel="stylesheet" href="/lib/public/global-training.css">
 
-<!-- NOTES
-
-**To-do**
-
-**Useful admonitions**
-
-> [!NOTE]  
-> Highlights information that users should take into account, even when skimming.
-
-> [!TIP]
-> Optional information to help a user be more successful.
-
-> [!IMPORTANT]  
-> Crucial information necessary for users to succeed.
-
-> [!WARNING]  
-> Critical content demanding immediate user attention due to potential risks.
-
-> [!CAUTION]
-> Negative potential consequences of an action.
-
-**Images** 
-
-![Test image](images/test-im.png "Example image placeholder")
-
--->
-
 ## About this lab
 
-<!-- This lab environment provides a controlled and secure platform to explore and experiment with a pre-configured Fusion application. The application is specifically designed for e-commerce functionalities and is populated with diverse datasets, offering users a rich sandbox for testing and learning. -->
+This lab environment provides a controlled and secure platform to explore and experiment with a pre-configured Fusion application. The application is specifically designed for e-commerce functionalities, including an expansive data source of electronics products and accessories and a library of query rewrites. 
 
 
 ### Datasources
 
-<!-- 1. **Pages.** Core Lucidworks website content containing informative sections about the Lucidworks' purpose, services, or general information.-->
-
-
-
-### Tour
-
-![Test image](images/test-im.png "Example image placeholder")
-
-> [!IMPORTANT]  
-> Add a Supademo tour here. 
-
-<!-- Supademo embed. -->
+There is one data source in the e-commerce playground: **Electronics**. The data source contains over 40,000 products, from televisions to printers, speakers, and home appliances. 
 
 ### What you can do
 
-<!-- In this secure application, you have the ability to:
+In this secure application, you have the ability to:
 
 * Create, modify, and delete index and query pipeline stages.
 * Work in the Query Workbench. 
 * Use the rules editor to create business rules, synonyms, misspelling corrections, and more. 
-* Play with Experience Optimizer to curate your ideal search experience.-->
+* Play with Predictive Merchandiser to curate your ideal search experience.
 
 ## Things to try
 
 ### Explore the data
 
-#### Datasources
-
-<!-- Each datasource is set up in a similar way, but there are some key differences. For example, some datasources have unique values declared in **Exclusive regexes**.
-
-![Exclusive RegEx for a datasource](images/datasource-exclusive-regex.png "Datasource exclusive RegEx")
-
-> [!NOTE]  
-> In many cases, key datasource configurations can be found in the advanced view. Toggle **Advanced** on to view these settings. -->
-
 #### Index pipelines
 
-<!-- Each datasource is pointed to a unique index pipeline, following a predictable naming pattern. For example, the blog datasource points to an index pipeline called `data-lucidworks-blog`.
+The index pipeline in this playground is a very basic configuration. There are only three pipeline stages, but Fusion is able to map the data to a useful format for query purposes.
 
-Navigate to **Indexing > Index pipelines**, then choose one of the `data-lucidworks-DATA_TYPE` pipelines. 
+Navigate to **Indexing > Index workbench**. Then, load the **electronics** data source. 
 
-Note that they all have **Call pipeline** stages called "Intake" and "Outtake." By routing data through these separate, shared index pipelines, Fusion ensures that the data is processed the same at certain phases of indexing. This avoids the need to duplicate work across multiple index pipelines. 
+Try adding some index pipeline stages to manipulate the fields and values in the documents before they are sent to Solr. Here are a couple of stages to try:
 
-![Call pipeline usage](images/index-pipeline-intake.png "Call pipeline index stages")
+* **Field Mapping**. The field mapping stage is a powerful stage commonly used to delete, add, set, copy, or move fields on a document. It allows you to perform small or bulk operations, such as deleting all unmapped fields.
+* **Regex Field Extraction**. The RegEx field extraction stage is used to pull out information from one field and place it in another. For example, if you have a field with the minimum and maximum temperatures stored in one string, but you wanted to separate the values, you can use this field to do so. 
 
-> [!TIP]
-> You can use a **Call pipeline** query pipeline stage for similar purposes.-->
+> [!IMPORTANT]  
+> The final stage in the index pipeline, **Solr Indexer** is crucial for getting documents to Solr. Turning it off, moving it, or removing it may break the pipeline.
 
 
 #### Query pipeline
 
 Head to the Query Workbench by navigating to **Querying > Query Workbench**.
 
-From here, you can enter a query and view the results. Try turning stages on and off, then investigate what changed in the results. You can also customize the facets in this view.
+From here, you can enter a query and view the results. Try turning stages on and off, then investigate what changed in the results. You can also customize the facets in this view. 
+
+> [!TIP]
+> This query pipeline makes use of facet fields and range facet fields. A range facet is already created for the regular price. Try creating a range facet for the sales price, `salePrice_d`. 
 
 ### Create signals
 
 In the Query Workbench, you can enable click signals to see how clicking on results affects the document's score (relevancy) and position within the results. 
 
 Click **Format Results**, select the **Send click signals** checkbox, and save your change. If you want to generate many signals at once, select the **Show signals generator** checkbox, and a simulate option appears when hold the pointer over a result.
 
-![Send click signals in Query Workbench](images/qwb-send-signals.png "Send click signals in Query Workbench")
+![Send click signals in Query Workbench](../../static/images/qwb-send-signals.png "Send click signals in Query Workbench")
+
+### Compare results before you save changes
+
+You can click the **Compare** button to compare the results list before and after a change. Try boosting a result:
+
+1. Enter a query term in the query work bench.
+1. Navigate to the second page of results, and choose one of the results. 
+1. Click the **Boost** button. The result is boosted to the first page. 
+
+To keep the boost, save the query pipeline. To discard the boost, close the query workbench, and choose not to save. 
 
 
 ### Create business rules
@@ -111,52 +78,46 @@ Navigate to **Relevance > Rules**, to reach the rules editor. Make sure you're o
 Some examples are already set up for you. 
 
 > [!TIP]
-> You can test these rules in Experience Optimizer. View the condition and the action of a rule. Replicate the action in Experience Optimizer, and the action will fire. 
+> You can test these rules in Predictive Merchandiser. View the condition and the action of a rule. Replicate the action in Predictive Merchandiser, and the action will fire. 
 
 ### Create rewrites
 
 Move to the **Rewrites** screen. Explore some of the rewrites that are already set up for you, such as misspelling and synonyms. 
 
 Add new rewrites, modify the existing ones, or delete everything to start over.
 
-### Play with Experience Optimizer
+### Play with Predictive Merchandiser
 
-Now that you've created some business rules and rewrites, navigate to Experience Optimizer to see how to create them from a natural search experience. 
+Now that you've created some business rules and rewrites, navigate to Predictive Merchandiser to see how to create them from a natural search experience. 
 
 > [!NOTE]  
 > Click the **Start task** button, if you want to start curating the search experience. 
 
 Begin by entering a search term in the search box. From the results list, you can choose to block a document from appearing, pin a document in its current position, bury a document lower in the result, or boost a document higher in the result. If you want to pin a document in a specific position, you can drag it where you want it.
 
-<div style="position: relative; padding-bottom: calc(51.78125% + 42px); height: 0;"><iframe src="https://app.supademo.com/embed/ft9Rms9EBaqQFnduqRt5P" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+<!-- <div style="position: relative; padding-bottom: calc(51.78125% + 42px); height: 0;"><iframe src="https://app.supademo.com/embed/ft9Rms9EBaqQFnduqRt5P" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div> -->
 
 Rules are created automatically from your interactions, and they are available to edit, delete, or publish in the **Rules** screen.
 
 To create query rewrites, enter a search term in the search box, and click the **Add** button that appears next to the term. Select any of the query rewrite options to create a new query rewrite. 
 
-<div style="position: relative; padding-bottom: calc(51.78125% + 42px); height: 0;"><iframe src="https://app.supademo.com/embed/V82C_bR_syCuDPuK48-PB" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+<!-- <div style="position: relative; padding-bottom: calc(51.78125% + 42px); height: 0;"><iframe src="https://app.supademo.com/embed/V82C_bR_syCuDPuK48-PB" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div> -->
 
-Like rules, query rewrites you create in Experience Optimizer are available in the **Rewrites** screen.
+Like rules, query rewrites you create in Predictive Merchandiser are available in the **Rewrites** screen.
 
 ## Challenges
 
 These challenges are meant to be open-ended. How you solve the challenge is entirely up to you. If you're stuck, check the [Lucidworks documentation](https://doc.lucidworks.com/). 
 
 ### Create your own landing template
 
-Templates help control the look and feel of Experience Optimizer, allowing you to design, test, and implement a wide variety of search experiences.
+Templates help control the look and feel of Predictive Merchandiser, allowing you to design, test, and implement a wide variety of search experiences.
 
-In Experience Optimizer, you can create a custom landing template popular with new or existing zones. 
+In Predictive Merchandiser, you can create a custom landing template popular with new or existing zones. 
 
 ### Configure triggers for a template
 
-You can trigger a template in Experience Optimizer based on conditions such as a time range, specific searches, or the URL context. If the required conditions are met, the template will load instead of the default, giving you fine-tuned control over the zone setup and layout. 
-
-### Resolve conflicting rules
-
-The rules editor automatically detects rules that may conflict with each other. In the business rules screen, you'll find several. 
-
-Fix the rules to resolve the warnings.
+You can trigger a template in Predictive Merchandiser based on conditions such as a time range, specific searches, or the URL context. If the required conditions are met, the template will load instead of the default, giving you fine-tuned control over the zone setup and layout. 
 
 ### Start working with tags
 
@@ -170,8 +131,7 @@ Congratulations on completing this software training lab! Now it's your turn to
 
 If you're ready to move on, we recommend the following resources: 
 
-* Training module
-* Training module
-* Training module
-* [Lucidworks documentation](https://doc.lucidworks.com/)
-* Ebook
+* [Fusion Signals](https://academy.lucidworks.com/advanced-signals)
+* [Predictive Merchandiser learning path](https://academy.lucidworks.com/path/predictive-merchandiser-learning-path)
+* [Refining Search Results learning path](https://academy.lucidworks.com/path/refining-search-results)
+* [Lucidworks documentation](https://doc.lucidworks.com/)

eLearning/playground-site-search/README.md

@@ -29,7 +29,7 @@ permalink: /playground-site-search/
 
 **Images** 
 
-![Test image](images/test-im.png "Example image placeholder")
+![Test image](images/IMAGE_NAME.png "Example image placeholder")
 
 -->
 
@@ -48,16 +48,6 @@ It is a basic implementation and serves as an excellent introduction to Fusion a
 1. **Events.** Information about gatherings, conferences, workshops, or other occurrences related to our industry, both past, present, and future.
 1. **Videos.** Visual content covering informative presentations, demonstrations, or discussions on industry-specific topics.
 
-
-### Tour
-
-![Test image](images/test-im.png "Example image placeholder")
-
-> [!IMPORTANT]  
-> Add a Supademo tour here. ^^^
-
-<!-- Supademo embed. -->
-
 ### What you can do
 
 In this secure application, you have the ability to:
@@ -107,7 +97,7 @@ In the Query Workbench, you can enable click signals to see how clicking on resu
 
 Click **Format Results**, select the **Send click signals** checkbox, and save your change. If you want to generate many signals at once, select the **Show signals generator** checkbox, and a simulate option appears when hold the pointer over a result.
 
-![Send click signals in Query Workbench](images/qwb-send-signals.png "Send click signals in Query Workbench")
+![Send click signals in Query Workbench](../../static/images/qwb-send-signals.png "Send click signals in Query Workbench")
 
 
 ### Create business rules

eLearning/scratchpad.md

@@ -0,0 +1,40 @@
+# Internal scratchpad
+
+A quick resource for writing playgrounds. 
+
+## Useful admonitions
+
+> [!NOTE]  
+> Highlights information that users should take into account, even when skimming.
+
+> [!TIP]
+> Optional information to help a user be more successful.
+
+> [!IMPORTANT]  
+> Crucial information necessary for users to succeed.
+
+> [!WARNING]  
+> Critical content demanding immediate user attention due to potential risks.
+
+> [!CAUTION]
+> Negative potential consequences of an action.
+
+## Images
+
+Image found in global directory:
+
+```
+![Image](../../static/images/IMAGE_NAME.png "Example image")
+```
+
+Image found in playground directory: 
+
+```
+![Image](images/IMAGE_NAME.png "Example image")
+```
+
+## Stylesheet
+
+```
+<link rel="stylesheet" href="/lib/public/global-training.css">
+```