Skip to content

Commit

Permalink
Merge pull request #87 from froboy/june-docs
Browse files Browse the repository at this point in the history
June docs
  • Loading branch information
froboy authored Jun 25, 2024
2 parents dc3176b + 74a35ab commit 51502bf
Show file tree
Hide file tree
Showing 31 changed files with 89 additions and 116 deletions.
5 changes: 4 additions & 1 deletion .linkcheck_skip.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@

https:/ycloudyusa/yusaopeny_docs/.*
mailto
email-protection
email-protection

# Skip checking print until we can fix some issues with images and links.
_print
29 changes: 20 additions & 9 deletions content/en/docs/development/Contributing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,36 @@
title: Contributing
---

The YMCA Website Services distribution is open source, and we welcome contributions from the YMCA Movement, the Drupal community, and beyond. Be sure to check our [Community Resources](/community) for how to get in touch and our [Roadmap](/roadmap) to see if your request is already in progress.

## Issues

If you have a support request, you've found a bug or you have a feature request:
- Search through known issues/requests [https:/YCloudYUSA/yusaopeny/issues](https:/YCloudYUSA/yusaopeny/issues)
- Create new issue [https:/YCloudYUSA/yusaopeny/issues/new](https:/YCloudYUSA/yusaopeny/issues/new)
If you have a support request, you've found a bug, or you have a feature request you can start in our primary repository, [YCloudYUSA/yusaopeny](https:/YCloudYUSA/yusaopeny):
- Search through [known issues/requests](https:/YCloudYUSA/yusaopeny/issues).
- [Create new issue](https:/YCloudYUSA/yusaopeny/issues/new).

If you are able to pinpoint the issue to a specific piece of functionality, you can open an issue on [the appropriate module](../decoupled--external--projects-of-openy).

## Pull Requests

If you have some time to make a contribution to the project, here are the steps that will help you:
- Create fork of [main project](https:/YCloudYUSA/yusaopeny). [How to create fork](https://help.github.com/articles/fork-a-repo/).
- Commit & push changes into your fork
- Create new Pull Request. [How to create Pull Request](https://help.github.com/articles/creating-a-pull-request/).
We use the GitHub ["Fork and pull model"](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models#fork-and-pull-model) for community contributions. If you have some time to make a contribution to the project, here are the steps that will help you:

- [Create a fork](https://help.github.com/articles/fork-a-repo/) of [YCloudYUSA/yusaopeny](https:/YCloudYUSA/yusaopeny).
- Commit & push changes into your fork.
- [Create new Pull Request](https://help.github.com/articles/creating-a-pull-request/).
- Write steps for review. In this way maintainers can go through steps on build to verify your fix/feature.
- Ensure steps for review added to README.md file in a module's/project's directory if it makes sense to check them on regular basis. Often this is needed for crucial parts of the system which is main business functionality of the component. Example of super simple steps for review [see in Quickstart section of location_finder module](https:/YCloudYUSA/yusaopeny/blob/8.x-1.x/modules/custom/location_finder/README.md#quickstart), please.
- Create Drupal tour module, based on steps for review and ship it with the module which provides a functionality.
- Ensure steps for review added to README.md file in a module's/project's directory if it makes sense to check them on regular basis. Often this is needed for crucial parts of the system which is main business functionality of the component. Example of super simple steps for review [see in Quickstart section of location_finder module](https:/YCloudYUSA/yusaopeny/blob/8.x-1.x/modules/custom/location_finder/README.md#quickstart), please.
- Wait for a CI build and ask maintainers for review.

**Important:** make sure your git email is associated with account on drupal.org, otherwise you won't get commits there.

## Merge Requests

Modules on Drupal.org follow their Merge Request process. The Drupal Wiki has in-depth documentation on these processes:

- [Overview of projects and issues](https://www.drupal.org/docs/develop/issues/overview-of-projects-and-issues)
- [Using GitLab to contribute to Drupal](https://www.drupal.org/docs/develop/git/using-gitlab-to-contribute-to-drupal)

## Drupal.org credits

If you would like to get drupal.org credits for your contribution:
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/user-documentation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ description: >

These documents are a combination of the former YMCA Website Services Community User Documentation and the [User Manual](https://drive.google.com/file/d/15aF_g7Q1ItOUNZUGR-6Tmlfz72m5ms2M/view?usp=sharing).

If you see something missing or would like to request a new topic, please [open an issue](https:/YCloudYUSA/yusaopeny_docs/issues/new?title=Open%20Y%20Distribution%20Documentation).
If you see something missing or would like to request a new topic, please [open an issue](https:/ycloudyusa/yusaopeny_docs/issues).
32 changes: 16 additions & 16 deletions content/en/docs/user-documentation/content-editing-basics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ title: Content Editing Basics
{{< youtube CHFXTW5B93Y >}}

## Adding New Content
To add a new piece of content, select the content tab in the administration toolbar at the top left.
To add a new piece of content, select the content tab in the administration toolbar at the top left.

![The content link in the admin menu](./basics-content.png)
![The content link in the admin menu](./basics-content.png)

Click the blue button that says “Add New Content.”

On the next page, select the type of content you want to add. **[Learn About Content Types ⇒](../content-types/)**

The fields on the next page marked with a red asterisk are required. To save your new piece of content, you must fill out the required fields.
The fields on the next page marked with a red asterisk are required. To save your new piece of content, you must fill out the required fields.

If this is a page that you do not want to be published, deselect the checkbox at the bottom left titled “Published.” This will mark it as a draft.

Expand All @@ -32,16 +32,16 @@ If you’re navigating your site and you’re logged in, you will see the follow
* Revisions
* Delete

![In-page Edit tab](./basics-tabs.png)
![In-page Edit tab](./basics-tabs.png)

You can edit a piece of content by clicking the “Edit” tab on that page.

To use the administration page, go to the top left button in your administration toolbar and select “Content.” This will take you to a page where you can search for content (particularly useful if you’re not sure where it is).
![Content type filtering](./basics-content-type.jpg)
![Content type filtering](./basics-content-type.jpg)

The text field on the left is a search field. Type in your content’s title to search.

If you’d like to narrow down the results, you can filter the results by
If you’d like to narrow down the results, you can filter the results by

* Content type
* Published Status
Expand All @@ -59,7 +59,7 @@ You can delete a content three ways:
* By selecting the Delete tab when you’re editing any page.
* By choosing Delete from the Dropdown on the results page.

You can also delete “in bulk” by ticking the checkmarks next to multiple rows of content on the content results page, selecting “Delete content” from the dropdown above the results table, and then clicking the “Apply to Selected” items.
You can also delete “in bulk” by ticking the checkmarks next to multiple rows of content on the content results page, selecting “Delete content” from the dropdown above the results table, and then clicking the “Apply to Selected” items.

This should only be done if you’re sure of which content you’re selecting to delete.

Expand All @@ -71,7 +71,7 @@ Each content type will have different fields based on the information you need t

These are one-line text boxes, such as page titles. Simply enter text into the box.

![Title field](./basics-title.png)
![Title field](./basics-title.png)

### Unformatted Textbox

Expand All @@ -83,15 +83,15 @@ Select one of the options provided. Occasionally, you’ll have to click a butto

### Multiselect Fields

![Locations field](./basics-location.png)
![Locations field](./basics-location.png)

Like a dropdown, but you can select multiple options by holding Control (Windows) or Command (Mac) and clicking on two or more selections.

### WYSIWYG/Formatted Text Editor

{{< youtube yyCsOP3GpQc >}}

A textbox that styles your text visually and allows you add links and embed different types of media.
A textbox that styles your text visually and allows you add links and embed different types of media.

[More on the Text Editor ⇒](../text-editor/)

Expand All @@ -101,15 +101,15 @@ Appears like a text field, but with a little circle off the right. Used for sear

Type in what you wish to enter, and then select from one of the optional results that appear below. Results will narrow as you type.

![Category field](./basics-category.gif)
![Category field](./basics-category.gif)

### Links/Button Fields

These will typically appear as a single box with two fields inside. They add a link onto a page, often as a button. The URL field is your link, which the Link Text is your call to action.’

![Link field](./basics-link.gif)
![Link field](./basics-link.gif)

The URL field supports both relative URLs for links on your site (e.g., /join for http://myymca.org/join) and full URLs for links on other sites (e.g., http://someotherymca.org/join).
The URL field supports both relative URLs for links on your site (e.g., /join for http://myymca.org/join) and full URLs for links on other sites (e.g., `http://someotherymca.org/join`).

You can also search for the title of a piece of content on your website and select a piece of content like in any other autocomplete field.

Expand All @@ -119,18 +119,18 @@ You can also search for the title of a piece of content on your website and sele

You can add, edit and upload images any time you see a tab with Image in the title. To use the media browser, click the button in the image field.

[More on Using the Image Library ⇒](../text-editor/adding-images.md)
[More on Using the Image Library ⇒](../text-editor/adding-images)

## Cloning Content

You can clone content using the "Clone" button on many pages... ![](./basics-clone-tabs.png)

or on the Content list in the site administration.
or on the Content list in the site administration.

![](./basics-clone-content.png)

Once you choose to clone a piece of content you will be presented with a complex screen asking which entities you would like to clone. In general, you can leave all of the checkboxes as they are. Changing the options could result in unintended consequences.

![](./basics-clone-options.png)

Scroll to the bottom of the checkbox options, choose **Take ownership** if you would like your user to own the new content, then **Save**.
Scroll to the bottom of the checkbox options, choose **Take ownership** if you would like your user to own the new content, then **Save**.
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Membership Content Type
description: Membership items are the building blocks of the [Membership Calculator](../../membership/calculator) and are only displayed within the Membership Calculator Paragraph.
description: Membership items are the building blocks of the Membership Calculator and are only displayed within the Membership Calculator Paragraph.
tags:
- "Membership Calculator"
---


See [Membership Calculator](../../membership/calculator).

---

Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/user-documentation/layout-builder/designs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ Based on the YMCA Brand Guide, the distribution contains four "colorways" that a

### Canadian Colourways

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

### Content Types

The distribution provides new [Content Types](../../content-types) for use with Layout Builder components.

| [Article](../../content-types/lb-article) | [Branch](../../content-types/lb-branch) | [Camp](../../content-types/lb-branch) | [Event](../../content-types/lb-event) |
|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
| [Article](../../content-types/lb-article) | [Branch](../../content-types/branch) | [Camp](../../content-types/camp) | [Event](../../content-types/lb-event) |
|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
| ![Article Content Type Design](<../../../../../assets/img/designs/lb-ui-kit/Article CT.jpg>) | ![Branch Content Type Design](<../../../../../assets/img/designs/lb-ui-kit/Branch CT.jpg>) | ![Camp Content Type Design](<../../../../../assets/img/designs/lb-ui-kit/Camp CT.jpg>) | ![Event Design](<../../../../../assets/img/designs/lb-ui-kit/Event.jpg>) |

### Components
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ The main navigation also supports an optional [nested CTA block](#main-menu-cta-
**Content**

- Menu items can be managed under **Structure** > **Menus** > **User account**.
- To show items with a button style, add the `highlighted` to the menu item under **Attributes** > **Class**.
![The menu item configuration with the highlighted class added. An overlay in the upper right corner shows the resulting link.](lb-header-footer--highlighted.png)

## Footer Section

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ description: Make it easy for your user to share content on social media.

> AddThis services have been deprecated as of 5/31/23
This block ceased functioning on May 31, 2023, with the discontinuation of [AddThis](https://www.addthis.com/) services.
This block ceased functioning on May 31, 2023, with the discontinuation of AddThis services.

See [Using AddToAny](../../../howto/add-social-feeds/#using-addtoany) for its replacement.
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Now, your internal link should take users to the exact location in the page that
* For links on your website, don’t use the full URL. Delete everything beginning with the `/` after your `.com`, `.org`, etc.
* For example, for ymca.org/about, you would choose /about. This is called the relative path, and it will help your analytics tracking.
* For links on other websites, grab the full URL, including the `https://`.
* For example, for example.org/about, you would choose https://example.org/about.
* For example, for example.org/about, you would choose `https://example.org/about`.
* For email links, add `"mailto:[email protected]."`

To update/change a link, click on the link text then click the link icon or use the popup options (in CKEditor 5).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Add the text for your link/button in the bottom left. Enter your link in the URL
* For links on your website, don’t use the full URL. Highlight everything beginning with the `/` after your `.com`, `.org`, etc.
* For example, for example.org/about, you would choose `/about`. This is called the relative path, and it will help your analytics tracking.
* For links on other websites, grab the full URL, including the `https://`.
* For example, for example.org/about, you would choose https://example.org/about.
* For example, for example.org/about, you should choose `https://example.org/about`.
* For email links, add `mailto:[email protected].`

[More on absolute vs relative links](https://www.coffeecup.com/help/articles/absolute-vs-relative-pathslinks/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Note, Daxko API access is required. Daxko charges an API usage fee.

You may require members to enter their bar code before accessing the site. Virtual Y will validate the barcode with Daxko prior to granting access.

[Set up Daxko Barcode Validation](./daxko-barcode.md).
[Set up Daxko Barcode Validation](./daxko-barcode).

## ReClique

Expand All @@ -40,4 +40,4 @@ An association may upload a membership CSV file indicating what members may acce

### CSV Upload with email verification

An association may upload a membership CSV file indicating what members may access the gated content. Members provide their email address and the Virtual Y site will require members access their email and click a link to gain access to the gated content.
An association may upload a membership CSV file indicating what members may access the gated content. Members provide their email address and the Virtual Y site will require members access their email and click a link to gain access to the gated content.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Virtual YMCA comes with four content types behind the login that are exclusive t

Bring the Y to your members when they’re away. Provide on-demand classes, activities for kids, and other video content. Great for health seekers, families and Active Older Adults.

Add Virtual Y Videos [one-by-one](../add-video/_index.md) or with the separate [Virtual Y Video Automation](https:/fivejars/vyva/wiki) application.
Add Virtual Y Videos [one-by-one](../add-video) or with the separate [Virtual Y Video Automation](https:/fivejars/vyva/wiki) application.

_Integrates with:_ YouTube and Vimeo

Expand All @@ -41,4 +41,4 @@ Do your members want to work out on their own but don’t know which workout the

Add Virtual Y Blog Posts can be added via the standard _Add Content_ list or menu.

_No integrations required._
_No integrations required._
Loading

0 comments on commit 51502bf

Please sign in to comment.