Skip to content

Commit

Permalink
Merge pull request #86 from froboy/june-docs
Browse files Browse the repository at this point in the history
Moar June Docs
  • Loading branch information
froboy authored Jun 14, 2024
2 parents 75979bc + aa42a9b commit dc3176b
Show file tree
Hide file tree
Showing 35 changed files with 299 additions and 189 deletions.
40 changes: 2 additions & 38 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,8 @@
YMCA Website Services style overrides.
*/

// Underline links by default
// @todo Remove when https:/google/docsy/pull/1684 is committed.
main a:not(.btn),
.td-footer a {
text-decoration: underline;
}

.td-box--dark p > a:hover {
color: #d9e5f8;
text-decoration: none;
}
// Add dark-mode support to code highlighting. See https://www.docsy.dev/docs/adding-content/lookandfeel/#lightdark-color-themes
@import 'td/code-dark';

// Swap the sidebar nav and utility position
aside.d-xl-block {
Expand All @@ -30,11 +21,6 @@ aside.d-xl-block {
}
}

// Increase contrast for ToC links.
.td-toc #TableOfContents a {
color: #5a5858;
}

figcaption {
font-style: italic;
font-size: 0.9rem;
Expand All @@ -51,15 +37,6 @@ dd {
margin-left: revert;
}

@media (min-width: 768px) {
@supports (position: sticky) {
.td-sidebar-nav {
max-height: calc(100vh - 4rem);
padding-top: 15px;
}
}
}

// Override Bootstrap's kbd styles
kbd {
display: inline-block;
Expand All @@ -81,20 +58,7 @@ kbd {
overflow-y: hidden;
}

footer .text-center .ml-1 a {
color: white;
}

// Hide the sidebar taxonomy cloud because `taxonomyCloud = []` stopped working
aside .taxonomy-terms-cloud {
display: none;
}

// Fix links in dark sections
.td-box--dark a {
color: #dddddd;

&:hover {
color: darken(#dddddd,10);
}
}
7 changes: 5 additions & 2 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ weight = 1
style = "tango"
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
guessSyntax = "true"
# Enable the color mode menu. See https://www.docsy.dev/docs/adding-content/lookandfeel/#lightdark-mode-menu
showLightDarkModeMenu = true
# Support code blocks in dark mode. See https://www.docsy.dev/docs/adding-content/lookandfeel/#lightdark-color-themes
noClasses = "false"

# Everything below this are Site Params

Expand Down Expand Up @@ -139,8 +143,6 @@ prism_syntax_highlighting = false
[params.ui]
# Set to true to disable breadcrumb navigation.
breadcrumb_disable = false
# Set to true to disable the About link in the site footer
footer_about_disable = false
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
navbar_logo = true
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
Expand All @@ -150,6 +152,7 @@ sidebar_menu_compact = true
sidebar_menu_foldable = true
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable = false
showLightDarkModeMenu = true

# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
Expand Down
104 changes: 104 additions & 0 deletions content/en/blog/releases/release-ds-10.3.3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
---
title: "Digital Services Release 10.3.3"
description: Annotated release notes. Full changelog on [GitHub](https:/YCloudYUSA/yusaopeny/releases/tag/10.3.3)
date: 2024-06-12
---

## Updates & New Features

### Drupal Updates

Learn more about the improvements in [Drupal 10.1](https://www.drupal.org/blog/drupal-10-1-0) and [Drupal 10.2](https://www.drupal.org/blog/drupal-10-2-0).

For users who wish to apply all the updates below _without_ Drupal 10.2, we've released [YMCA Website Services 10.3.2.4](https:/YCloudYUSA/yusaopeny/releases/tag/10.3.2.4). This can be applied as a stepping stone to Drupal 10.2, but we recommend moving to 10.2 as community security support for Drupal 10.0 [ended in December 2023](https://endoflife.date/drupal).

* Updated to Drupal core version 10.2. (#758)
* **NOTE:** This release will work with Drupal 10.1 or Drupal 10.2. Run `composer require drupal/core-recommended:"^10.1" -W` to force your site to use Drupal 10.1.
* Updated to OpenY map version 5.2. (#1497)

### Layout Builder Updates

Continuing general cleanup, updated documentation, and improvements to the content editing experience for new Layout Builder components and content types.

Learn more in [Layout Builder](/docs/user-documentation/layout-builder/).

* **Memberships** - Membership Calculator can be placed in a page using Layout Builder. (#555)
* **Schedules** - Schedules can be placed in a page using Layout Builder. (#1341)
* **Mega Menu** - Allow main menu items with <nolink>. (#1299)
* **Footer** - Added hover states to Y footer logo and social icons, fixed spacing on social icons. (#1356)
* **Events** - Made End Date/Time field optional. (#1386)
* **Events** - Set up metatags and configured Schema.org for new Layout Builder Events content type. (#849)
* **Events** - Enabled ‘Schedule for publishing’ option for the Layout Builder Event content type for content editors to schedule an event to publish at a specific date / time. (#1359)
* **Articles** - Enabled ‘Schedule for publishing’ option for the Layout Builder Article content type for content editors to schedule an article to publish at a specific date / time. (#1492)
* **Landing Pages** - Enabled ‘Schedule for publishing’ option for the Layout Builder Landing Page content type for content editors to schedule landing pages to publish at a specific date / time. (#1493)
* **Cards** - Improved styling for buttons using the "overlapping" style configuration. (#1305)
* **Cards** - Added text formatting to the Card description field. (#1464)
* **Branch Amenities** - Made field_amenities_icon optional so that content editors do not have to include icons. (#1401)
* **Alerts** - Translated Alerts should show the correct/current language. (#1453)

### Design System Updates

* **Colorways** - Updated Search Results page to match the 4 Colorways. (#1398)
* **Colorways** - Updated Activity Finder to match the 4 Colorways. (#1340)
* **Colorways** - Ensured Montserrat is being used as the Heading font for Canadian Colorway. (#1407)
* **Colorways** - Ensured Montserrat is being used as body text for the Canadian Colorway. (#1378, #1454)
* Added support for responsive favicons to the Distribution. (#1287)

### Activity Finder Updates

* Added advanced filtering to include additional filters. (#384)
* Time of day
* Start month
* Duration
* Included in Membership

### Internal Weekly Schedules Updates

* Y admins can now access the Create/Edit form component on the FrontEnd APP in the Schedules admin interface. (#1276)
* Changed configuration for the color picker field so it is set via the category in the activity content type, and not in the session. (#1400)
* Fixed an issue with the close button being hidden for the Schedules modal. (#1388)

### Admin / Content Editor Enhancements

* Fixed the height for the media directories browser so that admins can view the footer section containing the "Select Media" button without resorting to scrolling. (#1417)
* Added help / description text for new Activity Finder filters. (#1494)

### Sandboxes

* Added a new sandbox for the Traction Rec Activity Finder integration. (#1328)

### Documentation

* TractionRec Integration - Documented how to [set up and configure the integration with TractionRec](/docs/development/program-event-framework/#syncers). (#1394)
* Camp Content Type - Documented how to use the [Camp Content Type](/docs/user-documentation/content-types/camp/) in Layout Builder. (#1313)

### Bug Fixes

* **Menus** - Fixed issue with menu links with long text not wrapping on mobile devices. (#1337)
* **LB Testimonials** - Adjusted the line height of the Testimonial component. (#1365)
* **Membership Framework** - Users no longer redirected to an empty page after selecting a membership product. (#1418)
* **LB Camp Menu / Microsite Menu** - Fixed issues with mobile Camp Menu styles. (#1422)
* **LB Donate** - Fixed issue with content editors not being able to add the Donate component. (#1425)
* Resolved PHP message: Error: Call to a member function getEntityTypeId() on null (#1426)
* **LB Cards** - Ensured Card top corner settings apply when no image is displayed. (#1431)
* **LB Cards** - Fixed issue with Overlay Card variation title spacing when no image is displayed. (#1432)
* **LB Cards** - Resolved an issue with incorrect button display for Cards with longer titles. (#1465)
* **LB Camp Content Type** - Ensured Alerts on Camp nodes can be closed on mobile devices. (#1450)
* **LB Home Branch Feature** - Resolved an issue where the branch location changes to the previously set location when the user unchecks the “Don’t ask me again” box. (#1421)
* **LB Accordion** - Added missing subheading/description field. (#1446)
* **LB Locations - Amenities Filters** - Fixed an issue where Amenities filters fail with content types that don't have amenities field. (#1449)
* **LB Alerts** - Fixed issue with Alerts containing markup in the description that are not getting hidden if they are longer than 150 characters. (#1455)
* **LB Alerts** - Resolved an issue with Alert display settings preventing Alerts from displaying. (#1403)
* **LB Locations - Amenities Filters** - Adjusted the Amenities Filter margins to prevent tops getting cut off. (#1457)
* **LB Ping Pongs** - Resolved an issue with images getting pixelated in ping pongs when the text area contains a lot of text. (#1349)
* **LB Tables** - Fixed missing table properties. (#1369)
* **LB Donate** - Fixed an error with external links failing to validate. (#1317)
* **LB Branch Content Type** - Email icon no longer shows if the email field is empty. (#1405)
* **LB Branch Amenities** - Fixed the colour of the open amenities icon. (#1406)
* **LB media browser** - Fixed an issue with videos not being able to be uploaded to LB components via the media browser. (#1342)
* **LB Camp CT** - Ensured the hamburger menu does not display if there are no menu links. (#1463)
* **LB Article / Event / Landing Page CTs** - Fixed the preview button when creating LB Articles, Events and Landing Pages. (#1498)
* **LB Promo Card** - Fixed an issue with the display of the icons. (#1430)
* **Virtual Y** - Fixed header on Virtual Y Sandboxes. (#1322)
* Fixed failing update hooks causing errors when updating distro versions. (#1510)
* Resolved some CMS login and content creation issues for admins. (#1471)
10 changes: 10 additions & 0 deletions content/en/docs/contribution-guidelines/docs-tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,13 @@ color: {{</* color 169 43 49 */>}}
color: {{< color "#a92b31" >}}
color: {{< color 169 43 49 >}}
```

## Remote Markdown files

The `include-remote-md` shortcode fetches a remote markdown file and includes it in the page. This happens only when your Docsy project is built, so future changes of the remote markdown file are only included when you rebuild your project. See [docsy#1739](https:/google/docsy/pull/1739)

If the file has a H1 (`# ....`) instead of frontmatter, you can put the title line in as the second parameter and it will be removed instead. For example:

```go-html-template
{{</* include-remote-md "https://raw.githubusercontent.com/google/docsy/main/README.md" "# Docsy" */>}}
```
11 changes: 6 additions & 5 deletions content/en/docs/development/Sandboxes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ And there are multiple sandbox environments:

[sandboxes.y.org](https://sandboxes.y.org/)

These sandboxes are based on the latest [stable release](https:/YCloudYUSA/yusaopeny/releases) of YMCA Website Services. They are set to rebuild completely overnight and clear their database and files every 2 hours.
These sandboxes are based on the latest [stable release](https:/YCloudYUSA/yusaopeny/releases) of YMCA Website Services. They are set to rebuild completely overnight and clear their database and files every 2 hours.

<details>
<summary>These sandboxes are built on CI by running:</summary>
Expand Down Expand Up @@ -76,7 +76,7 @@ ansible-playbook docroot/reinstall.yml -i /tmp/inventory5068801741271597001.ini

## Feature-based sandboxes

We also maintain sandboxes with specific features enabled. Each of these builds
We also maintain sandboxes with specific features enabled. Each of these builds

### Virtual Y Sandboxes

Expand Down Expand Up @@ -106,10 +106,11 @@ ansible-playbook docroot/reinstall.yml -i /tmp/inventory13097841656330601319.ini

### Activity Finder Sandboxes

| Theme | Link | YMCA Website Services | Profile | Activity Finder | Theme | Bootstrap |
| Theme | Link | WS Profile | Activity Finder | Theme | Bootstrap |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- |
| Carnation | https://sandbox-carnation-cus-d9.y.org/activity-finder-v4 | stable | Custom | v4 dev | v4 |
| Rose | https://sandbox-rose-cus-d9.y.org/activity-finder-v4 | stable | Custom | v4 dev | v3 |
| Carnation (with TractionRec importer) | https://traction-ws.y.org/ | stable | Custom | v4 dev | v4 |
| Rose | https://sandbox-rose-cus-d9.y.org/activity-finder-v4 | stable | Custom | v4 dev | v3 |
| Lily | https://sandbox-lily-cus-d9.y.org/activity-finder-v4 | stable | Custom | v4 dev | v3 |

<details>
Expand All @@ -136,4 +137,4 @@ drush cset -y openy_activity_finder.settings bs_version 4 || true

```

</details>
</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: PEF Schedules
description: The "PEF Schedules" module allows Ys to create and manage schedules with a simple, calendar-based view.
tags:
- "Decoupled Applications"
---

[YCloudYUSA/y_pef_schedule](https:/YCloudYUSA/y_pef_schedule)

[comment]: <> (This file is imported from GitHub. It will be rebuilt from the source any time the repo is updated.)
{{< include-remote-md "https:/YCloudYUSA/y_pef_schedule/raw/main/README.md" "# Y PEF Schedule" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Traction Rec Integration
description: Instructions for configuring and importing data from Traction Rec into the Program Event Framework
---

Via [Traction Rec Integration (`ycloudyusa/openy_traction_rec`)](https:/YCloudYUSA/openy_traction_rec)

- [How to configure the Traction Rec integration](https:/YCloudYUSA/openy_traction_rec?tab=readme-ov-file#ymca-website-services-traction-rec-integration)
- [How to import data from Traction Rec](https:/YCloudYUSA/openy_traction_rec/blob/main/modules/openy_traction_rec_import/README.md#ymca-website-services-traction-rec-pef-integration)

## Configure

[comment]: <> (This file is imported from GitHub. It will be rebuilt from the source any time the repo is updated.)
{{< include-remote-md "https:/YCloudYUSA/openy_traction_rec/raw/main/README.md" "# YMCA Website Services Traction Rec integration" >}}

## Import

{{< include-remote-md "https:/YCloudYUSA/openy_traction_rec/raw/main/modules/openy_traction_rec_import/README.md" "# YMCA Website Services Traction Rec PEF integration" >}}
77 changes: 77 additions & 0 deletions content/en/docs/howto/canada/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: "How to use the Canadian Colourway for Layout Builder"
linkTitle: "use the Canadian Colourway"
description: With a few clicks, Canadian YMCAs can use their own set of brand-compliant, accessible styles.
---

YMCA of the USA has partnered with [YMCA Canada](https://www.ymca.ca/) to create a brand-compliant and accessible colourway for use by Canadian YMCAs.

![The logo and header from an example Canadian YMCA page](canada--example.png)

## Designs

The colourway is packaged as the [Canada Layout Builder Colorway](https://www.drupal.org/project/ws_colorway_canada) on Drupal.org and is included with the full [YMCA Layout Builder](https:/YCloudYUSA/y_lb) package.

- [YMCA Canada UI Kit](https://www.figma.com/proto/nQ8GfYR5CXkkaOxYAlITeC/YMCA-Canada-Design-System?type=design&node-id=614-11498&t=aGKtr2E2dDMfsYsF-1&scaling=min-zoom&page-id=614%3A11497&mode=design)
- [YMCA Canada Components](https://www.figma.com/proto/nQ8GfYR5CXkkaOxYAlITeC/YMCA-Canada-Design-System?type=design&node-id=1640-14094&t=H3ljPnNvxOWrGqhd-0&scaling=scale-down&page-id=1640%3A10978&starting-point-node-id=1640%3A14094)
- [YMCA Canada Demo Pages](https://www.figma.com/proto/nQ8GfYR5CXkkaOxYAlITeC/YMCA-Canada-Design-System?type=design&node-id=2201-21973&t=feeJM61aY5EhpgKl-1&scaling=min-zoom&page-id=2201%3A20920&mode=design)

### Colourways

![Four buttons with the four Y Canada color options](canada--color-schemes.png)
![Canadian Color schemes](canada--colors.png)

The Canadian Colorway package includes four options for content type or page-level colorways. Each colourway uses the same three primary colors - dark red, lighter red, and grey, along with a highlight color of blue, purple, green, or black.

### Banners

![Examples of the 4 Canadian banner variations](canada--banners-desktop.png)

The Canadian Colorway for Banners package contains 4 banner variations that utilize the unique Y Canada chevron:

- Black
- Red
- White
- Short (no image, title and subtitle only)

![Canadian banner variations in the Layout Builder style picker](canada--banners.png)

These can be selected in the [Y Styles](../../user-documentation/layout-builder/advanced-options/#y-block-styles) selector for each banner on your site.

Y Canada sites can also use the existing "Overlay" Banner style as it does not utilize any YUSA-specific styling.

## Setup

### Enable the required modules

{{% alert title="Warning" %}}
Enabling `ws_colorway_canada` will immediately changes the site logo from the Y-USA logo to the Y Canada logo, so this should be done on a development environment first.
{{% /alert %}}

The [`ws_colorway_canada`](https://www.drupal.org/project/ws_colorway_canada) module and its submodule `lb_hero_canada` contain [colorways, logos, and banner styles](#designs) approved by Canadian Y authorities.

- Visit **Admin** > **Extend** (`admin/modules`) and enable these two modules (search for `Canad`):
- Layout Builder - Canadian Colorway (`ws_colorway_canada`)
- Y Layout Builder - Canada Colorway for Banner (`lb_hero_canada`)
- Alternatively, enable the modules via `drush`:
```
drush en ws_colorway_canada lb_hero_canada -y
```

### Configure site defaults

After enabling the new colorway, there are a few more steps to ensure the new colorways are used across your site:

1. Set the [default layout styles](../set-up-lb#configure-layouts--listings) to use the Canadian colorway of your choice.
2. For any existing demo content, change the banner style to one of the new [Y Canada Styles](../../user-documentation/layout-builder/advanced-options/#y-block-styles).

### Hide YUSA Styles

Y Canada site developers may want to hide the existing YUSA styles in order to prevent unintentional usage. This is not possible through configuration at the moment, but some custom css can do the trick:

```css
#edit-ws-design-settings-colorway .form-item-ws-design-settings-colorway:has(div[class*="colorway-ws"]),
#drupal-off-canvas .form-item-appearance-ws-style-ws-style-option-hero-banner:not(:has(input[value*="canada"])) {
display: none;
}
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/docs/howto/canada/canada--banners.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/docs/howto/canada/canada--colors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/docs/howto/canada/canada--example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 1 addition & 5 deletions content/en/docs/howto/set-up-lb/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,4 @@ Then require and enable [`yusaopeny_activity_finder`](https:/YCloudY

## Canadian YMCAs

For Canadian YMCA sites, enable [`ws_colorway_canada`](https://www.drupal.org/project/ws_colorway_canada) and its submodule `lb_hero_canada`. These modules contain [colorways, logos, and banner styles](../../user-documentation/layout-builder/designs/#canadian-colourways) approved by their local Y authorities.

- After enabling the new colorway, be sure to set the [default layout styles](#configure-layouts--listings) to use the Canadian colorway of your choice.
- Enabling `ws_colorway_canada` will immediately change the site logo from the Y-USA logo to the Y Canada logo, so this should be done on a development environment first.

See [How to use the Canadian Colorway for Layout Builder](../canada).
Loading

0 comments on commit dc3176b

Please sign in to comment.