Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
srenon committed Jun 14, 2019
1 parent ee23956 commit 8222648
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 29 deletions.
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Preview Order Confirmation Page for Magento 2

[![Total Downloads](https://poser.pugx.org/magepal/magento2-preview-checkout-success-page/downloads)](https://packagist.org/packages/magepal/magento2-preview-checkout-success-page)
[![Latest Stable Version](https://poser.pugx.org/magepal/magento2-preview-checkout-success-page/v/stable)](https://packagist.org/packages/magepal/magento2-preview-checkout-success-page)
[![Total Downloads](https://poser.pugx.org/magepal/magento2-preview-checkout-success-page/downloads)](https://www.magepal.com/preview-order-confirmation-page-for-magento-2.html)
[![Latest Stable Version](https://poser.pugx.org/magepal/magento2-preview-checkout-success-page/v/stable)](https://www.magepal.com/preview-order-confirmation-page-for-magento-2.html)

Styling and testing Magento's order confirmation page can be a very difficult and time-consuming process since the order success page display is only displayed once after completing the lengthy checkout process. Changing your page content or testing a new CSS style will automatically redirect you to an empty shopping cart page on page refresh.

Expand All @@ -26,32 +26,18 @@ To avoid tracking of duplicate order information on your live site, you may want

This module was intended for development, testing, and staging environment. Please consider carefully before using in a production environment because it may affect your analytics/conversion data.

## Documentation

## Installation
- [How to Installing Order Success Page Previewer](https://www.magepal.com/help/docs/preview-order-conformation-page-magento-2/#installation)

- [How to Configure Order Confirmation Page Preview](https://www.magepal.com/help/docs/preview-order-conformation-page-magento-2/#configuration)

#### Step 1
##### Using Composer (recommended)
## Installation

```
composer require magepal/magento2-preview-checkout-success-page
```


##### Manual Installation
To install Checkout Previewer for Magento2
* Download the extension
* Unzip the file
* Create a folder {Magento root}/app/code/MagePal/PreviewCheckoutSuccessPage
* Copy the content from the unzip folder
* Flush cache

#### Step 2 - Enable Lazy Load for Magento2
* php -f bin/magento module:enable --clear-static-content MagePal_PreviewCheckoutSuccessPage
* php -f bin/magento setup:upgrade

#### Step 3 - Config Checkout Previewer for Magento2
Log into your Magento Admin, then goto Stores -> Configuration -> MagePal -> Checkout

Contribution
---
Want to contribute to this extension? The quickest way is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).
Expand All @@ -63,8 +49,22 @@ If you encounter any problems or bugs, please open an issue on [GitHub](https://

Need help setting up or want to customize this extension to meet your business needs? Please email [email protected] and if we like your idea we will add this feature for free or at a discounted rate.

Other Extensions
Magento 2 Extensions
---
[Custom SMTP](https://www.magepal.com/magento2/extensions/custom-smtp.html) | [Google Tag Manager](https://www.magepal.com/magento2/extensions/google-tag-manager.html) | [Enhanced E-commerce](https://www.magepal.com/magento2/extensions/enhanced-ecommerce-for-google-tag-manager.html) | [Google Universal Analytics](https://www.magepal.com/magento2/extensions/google-universal-analytics-enhanced-ecommerce.html) | [Reindex](https://www.magepal.com/magento2/extensions/reindex.html) | [Custom Shipping Method](https://www.magepal.com/magento2/extensions/custom-shipping-rates-for-magento-2.html) | [Preview Order Confirmation](https://www.magepal.com/magento2/extensions/preview-order-confirmation-page-for-magento-2.html) | [Guest to Customer](https://www.magepal.com/magento2/extensions/guest-to-customer.html) | [Admin Form Fields Manager](https://www.magepal.com/magento2/extensions/admin-form-fields-manager-for-magento-2.html) | [Customer Dashboard Links Manager](https://www.magepal.com/magento2/extensions/customer-dashboard-links-manager-for-magento-2.html) | [Lazy Loader](https://www.magepal.com/magento2/extensions/lazy-load.html) | [Order Confirmation Page Miscellaneous Scripts](https://www.magepal.com/magento2/extensions/order-confirmation-miscellaneous-scripts-for-magento-2.html)
- [Custom SMTP](https://www.magepal.com/magento2/extensions/custom-smtp.html)
- [Catalog Hover Image for Magento](https://www.magepal.com/magento2/extensions/catalog-hover-image-for-magento.html)
- [Enhanced Success Page for Magento 2](https://www.magepal.com/magento2/extensions/enhanced-success-page.html)
- [Enhanced Transactional Emails for Magento 2](https://www.magepal.com/magento2/extensions/enhanced-transactional-emails.html)
- [Google Tag Manager](https://www.magepal.com/magento2/extensions/google-tag-manager.html)
- [Enhanced E-commerce](https://www.magepal.com/magento2/extensions/enhanced-ecommerce-for-google-tag-manager.html)
- [Reindex](https://www.magepal.com/magento2/extensions/reindex.html)
- [Custom Shipping Method](https://www.magepal.com/magento2/extensions/custom-shipping-rates-for-magento-2.html)
- [Preview Order Confirmation](https://www.magepal.com/magento2/extensions/preview-order-confirmation-page-for-magento-2.html)
- [Guest to Customer](https://www.magepal.com/magento2/extensions/guest-to-customer.html)
- [Admin Form Fields Manager](https://www.magepal.com/magento2/extensions/admin-form-fields-manager-for-magento-2.html)
- [Customer Dashboard Links Manager](https://www.magepal.com/magento2/extensions/customer-dashboard-links-manager-for-magento-2.html)
- [Lazy Loader](https://www.magepal.com/magento2/extensions/lazy-load.html)
- [Order Confirmation Page Miscellaneous Scripts](https://www.magepal.com/magento2/extensions/order-confirmation-miscellaneous-scripts-for-magento-2.html)
- [HTML Minifier for Magento2](https://www.magepal.com/magento2/extensions/html-minifier.html)

© MagePal LLC. | [www.magepal.com](http:/www.magepal.com)
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"magepal/magento2-checkout-success-misc-script":"Add miscellaneous HTML and scripts to your checkout success page"
},
"type": "magento2-module",
"version": "1.0.6",
"version": "1.0.7",
"autoload": {
"files": [
"registration.php"
Expand Down
37 changes: 32 additions & 5 deletions etc/adminhtml/system.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,39 @@
<label>Preview Success Page</label><attribute type="expanded">1</attribute>
<comment>
<![CDATA[
<strong>Copyright © 2018 <a href="http://bit.ly/MPEXPCSP" target="_blank">www.magepal.com</a> / <a href="mailto:[email protected]">[email protected]</a></strong><br />
Design beautiful order confirmation page with our new
<a href="https://www.magepal.com/enhanced-success-page.html">Enhanced Success Page</a> extension.
Thanks for choosing MagePal Extensions.<br/><br/>
<div id="magepal-info-pcsp">
Copyright © 2019 <a href="https://www.magepal.com/magento2/extensions.html?utm_source=preview-conformation-page&utm_medium=admin" target="_blank">MagePal, LLC</a>
<a href="https://www.magepal.com/help/docs/preview-order-conformation-page-magento-2/?utm_source=preview-conformation-page&utm_medium=admin#documentation" target="_blank">Documentation</a>
<a href="https://www.magepal.com/help/docs/preview-order-conformation-page-magento-2/?utm_source=preview-conformation-page&utm_medium=admin#support">Support</a>
<a href="https://www.magepal.com/help/docs/preview-order-conformation-page-magento-2?utm_source=preview-conformation-page&utm_medium=admin#current_version" target="_blank">Latest Version</a>
<a href="https://www.magepal.com/preview-order-confirmation-page-for-magento-2.html?utm_source=preview-conformation-page&utm_medium=admin" target="_blank">Extension Detail</a>
<a href="https://www.magepal.com/magento2/extensions.html?utm_source=preview-conformation-page&utm_medium=admin" target="_blank">More Extensions</a>
</div>
<div>
Design beautiful order confirmation page with our new <a href="https://www.magepal.com/enhanced-success-page.html">Enhanced Success Page</a> extension.
</div>
<hr style="border-top: 1px solid #e3e3e3" />
]]>
<style>
#magepal-info-pcsp a {
font-weight: bold;
border-left: 2px solid #e3e3e3;
padding-left:10px;
padding-right:10px;
color: #ef7e1e;
}
#magepal-info-pcsp a:first-child {
padding-left: 5px;
border-left: none;
}
#magepal-info-pcsp {
padding-bottom: 5px;
}
.section-config.active #magepal_checkout_preview_success_page-head {
padding-bottom: 0px;
}
</style>]]>
</comment>
<field id="module_version" translate="label" type="label" sortOrder="0" showInDefault="1" showInWebsite="0" showInStore="0">
<label>Module Version</label>
Expand Down

0 comments on commit 8222648

Please sign in to comment.