RubyGems - workarea - Versions diffs - 3.4.16 → 3.4.17 - Mend

workarea 3.4.16 → 3.4.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (572) hide show

data/docs/source/articles/themes-overview.html.md DELETED Viewed

@@ -1,155 +0,0 @@
----
-title: Themes Overview
-excerpt: A Workarea theme is a specialized type of Workarea plugin. Themes specifically customize the appearance of the Workarea platform.
----
-# Themes Overview
-A Workarea theme is a specialized type of Workarea plugin. Themes specifically
-customize the appearance of the Workarea platform. Themes allow for re-use of
-storefront code, helping to jump-start front-end work for an implementation. A
-theme may be used as a starting point for front-end development, or as a
-complete storefront UI.
-## Installing a theme in a Workarea application
-Installing a theme in a Workarea application is like installing any other plugin.
-Add the theme's gem to your application's gemfile:
-```ruby
-  gem 'workarea-your_theme_name'
-```
-Then run `bundle install` and restart your application.
-Some themes may need extra configuration. Check the README.md for the theme you
-are using to see if any further configuration is necessary.
-## Configuring a theme
-All themes include a `config/initializer/theme.rb` file, which provides options
-for configuration within the Workarea application.
-Typically themes allow configuration for color schemes and font families.
-An example of a Workarea theme configuration file:
-```ruby
-Workarea.configure do |config|
-  config.theme = {
-    color_schemes: ["one", "workarea", "midnight"],
-    color_scheme: "one",
-    font_stacks: {
-      roboto: '"Roboto", "HelveticaNeue", "Helvetica Neue", sans-serif',
-      lora: '"Lora", "Times New Roman", "Georgia", serif',
-      hind: '"Hind", Helvetica, Arial, sans-serif',
-      source_serif_pro: '"Source Serif Pro", "Times New Roman", Georgia, serif',
-      muli: '"Muli", Helvetica, Arial, sans-serif',
-      playfair_display: '"Playfair Display", "Times New Roman", Georgia, serif'
-    },
-    primary_font_family: "roboto",
-    secondary_font_family: "lora"
-  }
-end
-```
-## Approaches to using a theme
-There are 2 ways to use a Workarea theme.
-1. Installing the theme as a gem in your application, similar to other plugins.
-2. As a development tool by running the `starter_store` generator to import a
-    theme's files to your application.
-### Gem vs. Development tool approach
-Using a Workarea theme as a gem is the quickest way to apply a theme to a Workarea
-application. The benefit of running a theme as a gem is getting bug-fixes and upgrades
-from the theme in patch releases.
-Using a theme as a development tool is an alternative way to use a Workarea theme.
-Rather than running the theme as a plugin; all of the theme's files, dependencies,
-and configurations are copied in to your application. This is done by running the
-`starter_store` generator from your host application. This approach allows greater
-flexibility in development, however it removes you from the direct upgrade path
-for the theme. This means you will need to use the Workarea upgrade tool to apply
-patches and upgrades as they are released for the theme.
-The development tool approach is most useful if:
-- You plan to customize the application heavily using the theme as a starting point.
-- You need to remove a dependency of the theme.
-  - For example a theme may depend on workarea-reviews, but your implementation uses
-    a 3rd party review system. The only way to use a theme and remove one of its
-    dependencies is by installing the theme using the `starter_store` generator.
-### Using a theme as a development tool
-To prepare for installing a theme as a starter store you must add the theme to
-your application gemfile and run `db:seed`. Once you have the theme running in your
-application run the `starter_store` generator
-```bash
-bundle exec rails g workarea:starter_store
-```
-During the execution of this generator you will be prompted to make decisions
-re. overriding existing files in your application. Use the Ynaqdh interface
-to make decisions on a per-file basis. I have found that 'n' is typically the
-preferable choice, with the exception of locales/en.yml
-After the generator is run you should:
-1. Run bundle install.
-2. Confirm that your application is running and is styled as expected.
-3. Remove the now commented-out theme from your gemfile.
-4. Run the full test suite and ensure nothing is failing.
-5. Commit your changes and open a pull-request.
-#### Appended files
-Appends, and append removals will still be handled via the imported appends.rb
-initializer. It is recommended that you review the contents of this file and
-update your host application where appropriate to include these appended files
-as normal, removing them from appends.rb. This is especially advisable for Sass
-and JS assets which can easily be added to your application manifests.
-## Upgrading a themed application
-If you have installed your theme using the `starter_store` generator the upgrade
-path is the same as any other application. The
-[Workarea upgrade tool](https://stash.tools.weblinc.com/projects/WL/repos/workarea-upgrade/browse)
-will be very helpful when upgrading your application.
-If your application is using a theme as a plugin you should follow these steps:
-1. Check whether your theme has already been upgraded for compatibility with the
-    version of Workarea you are upgrading to.
-    - If the theme is not yet upgraded contact the theme developer and find out
-    when that will be complete. It is not recommended to upgrade your application
-    until the theme is ready.
-2. Upgrade Workarea and all other plugins first, use the Workarea upgrade tool to
-    create a diff and make the necessary changes in your application.
-3. Update the theme's version in your gemfile to use the latest version that is
-    compatible with your new Workarea version.
-4. Run the upgrade tool against your theme to see if there are further changes
-    that need to be made to files that have been overridden in your application.
-Once all necessary changes highlighted in the diff have been made, tests are
-passing, and your PR has been accepted, your application is upgraded and should
-be sent to QA for testing. Drink a beer, you've earned it!
-## Multisite support for themes
-Multisite applications are able to use Workarea themes without many changes to
-the normal multi-site development workflow.
-Configuration options set in theme.rb should be applied to each instance of
-`Workarea::Site`, this allows you to easily apply different color schemes and
-fonts to each site with minimal effort. Skinning a new site for a themed
-multi-site app should be relatively simple!
-It is not possible to use more than 1 theme per application. This means you cannot
-use different themes for different sites within a multi-site application. All sites
-must be based on the same theme, but each can customize away from the theme as necessary.
-Follow the [instructions for working with multi-site applications](https://stash.tools.weblinc.com/projects/WL/repos/workarea-multi-site/browse)
-for more information about developing multi-site applications.

data/docs/source/articles/translate-administrable-content.html.md DELETED Viewed

@@ -1,14 +0,0 @@
----
-title: Translate Administrable Content
-excerpt: Many fields available through the Admin UI can be localized. These fields are indicated by a localization icon.
----
-# Translate Administrable Content
-Many fields available through the Admin UI can be localized. These fields are indicated by a localization icon.
-To set the value of these fields for a different locale, use the locale switcher at the top of the Admin screen.
-Translations of administrable content are stored with [Mongoid-localized fields](https://docs.mongodb.com/mongoid/6.4/tutorials/mongoid-documents/#localized-fields).
-**Note:** This functionality will appear only if more than one locale is configured on the `I18n` module.

data/docs/source/articles/translate-javascript-content.html.md DELETED Viewed

@@ -1,16 +0,0 @@
----
-title: Translate JavaScript Content
-excerpt: Translate text within JavaScript templates and modules using the I18n.t() method provided by i18n-js (bundled with Workarea).
----
-# Translate JavaScript Content
-Translate text within JavaScript [templates](javascript-templates.html) and [modules](javascript-modules.html) using the `I18n.t()` method provided by [i18n-js](https://github.com/fnando/i18n-js) (bundled with Workarea).
-The library provides access to the translations in `config/locales`, the same locale files used for [localization of static text in Ruby code](translate-or-customize-static-content.html).
-workarea-storefront/app/assets/javascripts/workarea/storefront/templates/log\_out\_link.jst.ejs:
-```
-<span> (<a href="<%= WORKAREA.routes.storefront.logoutPath() %>" data-analytics="{'event':'logout', 'domEvent':'click'}" ><%= I18n.t('workarea.storefront.users.logout') %></a>)</span>
-```

data/docs/source/articles/translate-or-customize-message-content.html.md DELETED Viewed

@@ -1,29 +0,0 @@
----
-title: Translate or Customize Message Content
-excerpt: Message text is translated/customized in the same manner as all static text.
----
-# Translate or Customize Message Content
-Message text is translated/customized in the same manner as all [static text](translate-or-customize-static-content.html).
-To customize or translate message text, create a local file in your app for each locale (if you haven't already) and edit the values for the keys that correspond to the messages you'd like to change.
-your\_app/config/locales/en.yml :
-```
-en:
-  workarea:
-    storefront:
-      # ...
-      flash_messages:
-        error: Error
-        no_search_query: You must enter a search term.
-        no_matching_order: We could not find a matching order. Please try again.
-        email_signed_up: Your email address has been added to our list.
-        email_signup_error: The provided email address was invalid.
-        contact_message_sent: Your message has been sent.
-        share_message_sent: Thanks for sharing! An email has been sent to %{recipient}.
-        # ...
-      # ...
-```

data/docs/source/articles/translate-or-customize-static-content.html.md DELETED Viewed

@@ -1,30 +0,0 @@
----
-title: Translate or Customize Static Content
-excerpt: All static, user-facing text in Workarea UIs (including messages and emails) is translated through Rails' t helper. Use of this helper is explained in the Rails Internationalization (I18n) API guide.
----
-# Translate or Customize Static Content
-All static, user-facing text in Workarea UIs (including messages and emails) is translated through Rails' `t` helper. Use of this helper is explained in the [Rails Internationalization (I18n) API guide](http://guides.rubyonrails.org/i18n.html).
-Translations are loaded from Yaml files in `config/locales` within your app.
-workarea-storefront/app/controllers/workarea/storefront/cart\_items\_controller.rb:
-```
-# ...
-flash[:success] = t('workarea.storefront.flash_messages.cart_item_added')
-# ...
-flash[:error] = t('workarea.storefront.flash_messages.cart_item_error')
-# ...
-```
-workarea-storefront/app/views/layouts/workarea/storefront/application.html.haml:
-```
-.value= email_field_tag :email, nil, id: 'footer_email_signup_field', class: 'text-box', placeholder: t('workarea.storefront.forms.email_placeholder'), title: t('workarea.storefront.users.email'), required: true
-```

data/docs/source/articles/use-an-existing-workarea-app.html.md DELETED Viewed

@@ -1,108 +0,0 @@
----
-title: Use an Existing Workarea App
-excerpt: A quick guide to set up a Workarea application.
----
-# Use an Existing Workarea Application
-This is a quick start guide for getting started on an existing Workarea application. If you're a developer who has a new ticket on an app you just cloned for the first time, this is for you. These steps were written with the following assumptions:
-* You have Docker Desktop installed. See [https://www.docker.com/products/docker-desktop](https://www.docker.com/products/docker-desktop) to download.
-* You have Ruby >= 2.4.0, < 2.7.0 installed. See [https://github.com/rbenv/rbenv#installation](https://github.com/rbenv/rbenv#installation) for instructions.
-* You have NodeJS installed. We recommend using [Homebrew](https://brew.sh).
-* You have ImageMagick installed. We recommend using [Homebrew](https://brew.sh).
-* You have the repository cloned locally.
-For more details, see [Prerequisites and Dependencies](prerequisites-and-dependencies.html).
-## Setup an Existing Workarea Application
-Follow the steps below to quickly set up an existing Workarea application.
-### 1. Check the README
-Lots of projects put helpful startup info in their README file. Give it a look and see if there's anything you need to know there. We'll continue this guide assuming nothing relevant or more specific is in there.
-```bash
-$ cat README.md
-```
-### 2. Bundle to install gem dependencies
-Workarea (and all Rails apps) depend on lots of gems, install the bundle to resolve and install the gems:
-```bash
-$ bundle install
-```
-### 3. Start Workarea service dependencies
-Workarea relies on a few databases, so there's a task that will start them in Docker containers.
-Start Workarea dependencies:
-```bash
-$ bin/rails workarea:services:up
-```
-### 5. Seed the database
-To do anything useful with Workarea, you'll want some sample data in your database.
-The install generator run in step 3 will add Workarea seeds to your `db/seeds.rb` file,
-so running Rails seeds will add sample Workarea data.
-```bash
-$ bin/rails db:seeds
-```
-For more details on working with seed data, see [Seeds](seeds.html).
-### 6. Start the Rails server
-Use the conventional Rails command for starting up the Puma server:
-```bash
-$ bin/rails server
-```
-### 7. Open the Application in a Browser
-Your Workarea application is ready! Open a browser, and check out `http://localhost:3000`.
-## Addendum
-### 8. Run Tests
-Running tests is a regular part of developing on Workarea. Check out the list of Rails tasks Workarea provides for testing Workarea:
-```bash
-$ bin/rails -T workarea:test
-rails workarea:test              # Run workarea tests (with decorators)
-rails workarea:test:admin        # Run workarea admin tests (with decorators)
-rails workarea:test:app          # Run all app specific tests
-rails workarea:test:core         # Run workarea/core tests (with decorators)
-rails workarea:test:decorated    # Run decorated tests
-rails workarea:test:performance  # Run workarea performance tests (with decorators)
-rails workarea:test:plugins      # Run all installed workarea plugin tests (with decorators)
-rails workarea:test:storefront   # Run workarea storefront tests (with decorators)
-```
-This will run the Workarea test suite (with any [decoration to the tests](decoration.html) this app adds):
-```bash
-$ bin/rails workarea:test
-```
-For more details on Workarea's testing functionality, see [Testing](testing.html).
-### 9. Stop the Services
-After developing and testing, you may want to stop the services to conserve resources on your machine.
-Run the command to stop the services Workarea has started for you:
-```bash
-$ bin/rails workarea:services:down
-```
-Note that the volumes these containers used will still be available, and you won't have to seed again the next time you start them.