workarea 3.4.12

data/docs/source/stylesheets/vendor/_normalize.scss

@@ -0,0 +1,341 @@
+/*! normalize.css v8.0.0 | MIT License | github.com/necolas/normalize.css */
+
+/* Document
+   ========================================================================== */
+
+/**
+ * 1. Correct the line height in all browsers.
+ * 2. Prevent adjustments of font size after orientation changes in iOS.
+ */
+
+html {
+  line-height: 1.15; /* 1 */
+  -webkit-text-size-adjust: 100%; /* 2 */
+}
+
+/* Sections
+   ========================================================================== */
+
+/**
+ * Remove the margin in all browsers.
+ */
+
+body {
+  margin: 0;
+}
+
+/**
+ * Correct the font size and margin on `h1` elements within `section` and
+ * `article` contexts in Chrome, Firefox, and Safari.
+ */
+
+h1 {
+  font-size: 2em;
+  margin: 0.67em 0;
+}
+
+/* Grouping content
+   ========================================================================== */
+
+/**
+ * 1. Add the correct box sizing in Firefox.
+ * 2. Show the overflow in Edge and IE.
+ */
+
+hr {
+  box-sizing: content-box; /* 1 */
+  height: 0; /* 1 */
+  overflow: visible; /* 2 */
+}
+
+/**
+ * 1. Correct the inheritance and scaling of font size in all browsers.
+ * 2. Correct the odd `em` font sizing in all browsers.
+ */
+
+pre {
+  font-family: monospace, monospace; /* 1 */
+  font-size: 1em; /* 2 */
+}
+
+/* Text-level semantics
+   ========================================================================== */
+
+/**
+ * Remove the gray background on active links in IE 10.
+ */
+
+a {
+  background-color: transparent;
+}
+
+/**
+ * 1. Remove the bottom border in Chrome 57-
+ * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
+ */
+
+abbr[title] {
+  border-bottom: none; /* 1 */
+  text-decoration: underline; /* 2 */
+  text-decoration: underline dotted; /* 2 */
+}
+
+/**
+ * Add the correct font weight in Chrome, Edge, and Safari.
+ */
+
+b,
+strong {
+  font-weight: bolder;
+}
+
+/**
+ * 1. Correct the inheritance and scaling of font size in all browsers.
+ * 2. Correct the odd `em` font sizing in all browsers.
+ */
+
+code,
+kbd,
+samp {
+  font-family: monospace, monospace; /* 1 */
+  font-size: 1em; /* 2 */
+}
+
+/**
+ * Add the correct font size in all browsers.
+ */
+
+small {
+  font-size: 80%;
+}
+
+/**
+ * Prevent `sub` and `sup` elements from affecting the line height in
+ * all browsers.
+ */
+
+sub,
+sup {
+  font-size: 75%;
+  line-height: 0;
+  position: relative;
+  vertical-align: baseline;
+}
+
+sub {
+  bottom: -0.25em;
+}
+
+sup {
+  top: -0.5em;
+}
+
+/* Embedded content
+   ========================================================================== */
+
+/**
+ * Remove the border on images inside links in IE 10.
+ */
+
+img {
+  border-style: none;
+}
+
+/* Forms
+   ========================================================================== */
+
+/**
+ * 1. Change the font styles in all browsers.
+ * 2. Remove the margin in Firefox and Safari.
+ */
+
+button,
+input,
+optgroup,
+select,
+textarea {
+  font-family: inherit; /* 1 */
+  font-size: 100%; /* 1 */
+  line-height: 1.15; /* 1 */
+  margin: 0; /* 2 */
+}
+
+/**
+ * Show the overflow in IE.
+ * 1. Show the overflow in Edge.
+ */
+
+button,
+input { /* 1 */
+  overflow: visible;
+}
+
+/**
+ * Remove the inheritance of text transform in Edge, Firefox, and IE.
+ * 1. Remove the inheritance of text transform in Firefox.
+ */
+
+button,
+select { /* 1 */
+  text-transform: none;
+}
+
+/**
+ * Correct the inability to style clickable types in iOS and Safari.
+ */
+
+button,
+[type="button"],
+[type="reset"],
+[type="submit"] {
+  -webkit-appearance: button;
+}
+
+/**
+ * Remove the inner border and padding in Firefox.
+ */
+
+button::-moz-focus-inner,
+[type="button"]::-moz-focus-inner,
+[type="reset"]::-moz-focus-inner,
+[type="submit"]::-moz-focus-inner {
+  border-style: none;
+  padding: 0;
+}
+
+/**
+ * Restore the focus styles unset by the previous rule.
+ */
+
+button:-moz-focusring,
+[type="button"]:-moz-focusring,
+[type="reset"]:-moz-focusring,
+[type="submit"]:-moz-focusring {
+  outline: 1px dotted ButtonText;
+}
+
+/**
+ * Correct the padding in Firefox.
+ */
+
+fieldset {
+  padding: 0.35em 0.75em 0.625em;
+}
+
+/**
+ * 1. Correct the text wrapping in Edge and IE.
+ * 2. Correct the color inheritance from `fieldset` elements in IE.
+ * 3. Remove the padding so developers are not caught out when they zero out
+ *    `fieldset` elements in all browsers.
+ */
+
+legend {
+  box-sizing: border-box; /* 1 */
+  color: inherit; /* 2 */
+  display: table; /* 1 */
+  max-width: 100%; /* 1 */
+  padding: 0; /* 3 */
+  white-space: normal; /* 1 */
+}
+
+/**
+ * Add the correct vertical alignment in Chrome, Firefox, and Opera.
+ */
+
+progress {
+  vertical-align: baseline;
+}
+
+/**
+ * Remove the default vertical scrollbar in IE 10+.
+ */
+
+textarea {
+  overflow: auto;
+}
+
+/**
+ * 1. Add the correct box sizing in IE 10.
+ * 2. Remove the padding in IE 10.
+ */
+
+[type="checkbox"],
+[type="radio"] {
+  box-sizing: border-box; /* 1 */
+  padding: 0; /* 2 */
+}
+
+/**
+ * Correct the cursor style of increment and decrement buttons in Chrome.
+ */
+
+[type="number"]::-webkit-inner-spin-button,
+[type="number"]::-webkit-outer-spin-button {
+  height: auto;
+}
+
+/**
+ * 1. Correct the odd appearance in Chrome and Safari.
+ * 2. Correct the outline style in Safari.
+ */
+
+[type="search"] {
+  -webkit-appearance: textfield; /* 1 */
+  outline-offset: -2px; /* 2 */
+}
+
+/**
+ * Remove the inner padding in Chrome and Safari on macOS.
+ */
+
+[type="search"]::-webkit-search-decoration {
+  -webkit-appearance: none;
+}
+
+/**
+ * 1. Correct the inability to style clickable types in iOS and Safari.
+ * 2. Change font properties to `inherit` in Safari.
+ */
+
+::-webkit-file-upload-button {
+  -webkit-appearance: button; /* 1 */
+  font: inherit; /* 2 */
+}
+
+/* Interactive
+   ========================================================================== */
+
+/*
+ * Add the correct display in Edge, IE 10+, and Firefox.
+ */
+
+details {
+  display: block;
+}
+
+/*
+ * Add the correct display in all browsers.
+ */
+
+summary {
+  display: list-item;
+}
+
+/* Misc
+   ========================================================================== */
+
+/**
+ * Add the correct display in IE 10+.
+ */
+
+template {
+  display: none;
+}
+
+/**
+ * Add the correct display in IE 10.
+ */
+
+[hidden] {
+  display: none;
+}

data/docs/source/stylesheets/vendor/highlight/_tomorrow_night_blue.scss

@@ -0,0 +1,75 @@
+/* Tomorrow Night Blue Theme */
+/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
+
+/* Tomorrow Comment */
+.hljs-comment,
+.hljs-quote {
+  color: #7285b7;
+}
+
+/* Tomorrow Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-tag,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class,
+.hljs-regexp,
+.hljs-deletion {
+  color: #ff9da4;
+}
+
+/* Tomorrow Orange */
+.hljs-number,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params,
+.hljs-meta,
+.hljs-link {
+  color: #ffc58f;
+}
+
+/* Tomorrow Yellow */
+.hljs-attribute {
+  color: #ffeead;
+}
+
+/* Tomorrow Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet,
+.hljs-addition {
+  color: #d1f1a9;
+}
+
+/* Tomorrow Blue */
+.hljs-title,
+.hljs-section {
+  color: #bbdaff;
+}
+
+/* Tomorrow Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+  color: #ebbbff;
+}
+
+.hljs {
+  display: block;
+  overflow-x: auto;
+  background: #002451;
+  color: white;
+  padding: 0.5em;
+}
+
+.hljs-emphasis {
+  font-style: italic;
+}
+
+.hljs-strong {
+  font-weight: bold;
+}

data/docs/source/upgrade-guides.html.md

@@ -0,0 +1,18 @@
+---
+title: Upgrade Guides
+excerpt: List of available Workarea upgrade guides
+body_class: body--nude
+---
+
+Upgrade Guides
+======================================================================
+
+Upgrade guides highlight the most important changes for developers upgrading an application or plugin to a newer minor or major version of the Workarea platform.
+
+When upgrading, also consider the [Workarea Upgrade](https://plugins.workarea.com/plugins/upgrade) plugin, which provides migration scripts, diffs, reports, and other tools to assist with Workarea upgrades.
+
+
+Upgrade Guides by Version
+----------------------------------------------------------------------
+
+- [Workarea 3.4.0](upgrade-guides/workarea-3-4-0.html)

data/docs/source/upgrade-guides/workarea-3-4-0.html.md

@@ -0,0 +1,152 @@
+---
+title: Workarea 3.4.0
+excerpt: Upgrade guide for Workarea 3.4.0
+---
+
+# Workarea 3.4.0
+
+Upgrade guide for Workarea 3.4.0.
+
+Before we get in to the details, I will assume that you are familiar with using
+the [Workarea Upgrade tool](https://plugins.workarea.com/plugins/upgrade). This
+is a fundamental part for every upgrade, and while we will refer to using it in
+this guide, we will not cover specific commands.
+
+## 3.4 Release Notes
+
+The full release notes for v3.4 are available here:
+<https://developer.workarea.com/release-notes/workarea-3-4-0.html>
+
+### Some stand-out changes to be aware of
+
+#### Dependency changes
+
+* Requires MongoDB 4.
+* Rails 5.2.0
+* Supports Ruby 2.6
+* Updates jQuery validate to 1.19.0
+* Sidekiq Unique Jobs 6
+* Active Shipping uses vendored copy
+* mongoid-simple-tags uses vendored copy
+* Removed dropzones.js from Admin
+
+#### Admin Changes
+
+* All admin dashboards are updated, with additional reports dashboards and views
+* Workarea::Analytics deprecated in favor of Workarea::Metrics
+* Improved insights content block
+* [Improved administration of Favicons](https://developer.workarea.com/articles/favicon-support.html)
+
+#### Storefront Changes
+
+* Now ships with a fully supported, simple, [PWA](https://developers.google.com/web/progressive-web-apps/).
+  Including a service worker for offline mode!
+* Taxonomy content blocks can now display the starting taxon as a link.
+* Better reporting on category and search conversions by adding 'via' tracking
+  for all products.
+* WORKAREA.breakPoints API made more predictable, removing the possibility of false
+  positives.
+* No longer suppress analytics events for admin users. This ensures alignment
+  between Workarea metrics and 3rd parties.
+* Updates Aria attributes and HTML to ensure W3C valid and accessible markup.
+* Improved support for Navigation and Search on large touchscreen devices
+* Change mobile filters UI to include the entire `#page-aside`
+
+## Important Changes in v3.4
+
+In v3.4 the following changes will need to be made to your application, you
+should account for this in your estimate.
+
+### MongoDB v4
+
+In order to support the new Metrics engine, which drives Admin insights and
+reporting. Workarea was upgraded to support MongoDB 4.
+
+You’ll need to coordinate v3.4 upgrade with the [Workarea support team](https://support.workarea.com)
+due to the MongoDB v4 requirement.
+
+If your application includes a `config/mongoid.yml` file, you may need to rename
+the database to align with autoconfiguration. This may involve changing or
+removing the mongoid.yml configuration in your project.
+
+#### Installing MongoDB 4 locally
+
+You will need to install MongoDB 4.0 in your local development environment, using
+either [the package/installer for your system](https://docs.mongodb.com/manual/installation/#mongodb-community-edition)
+or Docker. If you are installing on your system, consider whether you still need
+to run MongoDB v3.x for other applications. Internally, the Workarea product team
+have found that stopping the MongoDB 3.x service and running MongoDB 4 in a docker
+container to be an effective approach. If your development happens entirely within
+a Docker environment using `docker-compose` you can update your docker-compose
+file to use a MongoDB 4.0 image.
+
+#### Bamboo Updates
+
+To support MongoDB v4 you will need to update your Bamboo configuration to use
+scripts.
+
+If your application already has a /script directory for bamboo you can update the
+existing scripts using the app template generator (see below) and will not need
+to change your bamboo configuration.
+
+If you do not have a /script directory you should create a new branch from master
+and add scripts for v3.3.x prior to doing your upgrade. The scripts are included
+in the app_template.rb and can be generated using the `app:template` command below.
+Once these scripts are merged in to master, QA and Staging branches you should
+[create a ticket for Workarea Support](https://jira.tools.weblinc.com/servicedesk/customer/portal/16/create/247)
+to update your bamboo build plan. Once your build plan is updated, all feature
+branches will need to rebase or merge in the changes from master to include the
+scripts directory.
+
+### Generating metrics and insights
+
+To populate your application's Metrics engine, and generate historical insights
+you need to run the generator provided in Workarea 3.4
+
+**Note:** Depending on order volume this could take a while to run in production.
+You should schedule running this task accordingly.
+
+```bash
+bundle exec rails workarea:insights:generate
+```
+
+### App Template updates
+
+There were a number of changes to the way new Workarea applications are
+configured. To save time finding and fixing those configurations. Or worse,
+dealing with bugs due to outdated configurations. You should run this command to
+update your application. Be sure to commit your work before running this, and
+check to ensure no custom configuration, which you may need to keep, was removed.
+**Run this script after you have bumped your application's Workarea version to v3.4.x**.
+
+```bash
+bundle exec rails app:template LOCATION=$(bundle show workarea)/docs/guides/source/app_template.rb
+```
+
+This script will offer the `Ynaqdhm` CLI interface when conflicts are detected.
+Using the `d` option to view a diff before deciding whether to accept or reject
+a change in each file is recommended.
+
+A few things to note about these configuration changes:
+
+* Puma configuration is now loaded from Workarea core, rather than being specified in the application.
+* Adds/Updates the Dockerfile.deploy to support Kubernetes infrastructure.
+* Auto configure `force_ssl` in production.rb
+* favicon.ico removed to support new favicon implementation
+* Adds initializer for basic auth configuration - **you should keep any existing configuration to prevent confusion**
+* Adds a placeholder_test.rb - this is for new applications and **should not be
+  committed** if you are upgrading an app that already has decorated or added tests
+
+## Update Overridden and Decorated Files
+
+Once you've made the important changes noted above, you're ready for the bulk of
+every upgrade. Use the [Workarea upgrade tool](https://stash.tools.weblinc.com/projects/WL/repos/workarea-upgrade/browse)
+to generate a diff, then work through the changes in each file. You will need to
+use your judgement to decide which changes to make, and which changes are not necessary.
+
+## Congratulations
+
+This should have gotten you from v3.3 to v3.4! If you're stuck, or have further
+questions, please [contact Workarea support](https://support.workarea.com).
+
+Feel free to include members of the Workarea Support team on your pull request.