This repository has been archived by the owner on Jan 27, 2023. It is now read-only.
generated from google/docsy-example
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: User Documentation > Content Types
- Loading branch information
Showing
10 changed files
with
611 additions
and
10 deletions.
There are no files selected for viewing
32 changes: 31 additions & 1 deletion
32
content/en/docs/user-documentation/content-types/activity-class-session.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,33 @@ | ||
| --- | ||
| title: Activity, Class, and Session | ||
| --- | ||
| --- | ||
|
|
||
| > These content types format data/content pulled from third parties, such as Daxko, Personify and ActiveNet, for display in Open Y. | ||
| Content editors rarely, if ever, enter information directly into these content types on a day-to-day basis. However, it is important to know how they work and how they relate to manually-entered content. | ||
|
|
||
| >**Example - Swim Lessons** | ||
| > * Swimming and Aquatics (Program Page, manually entered) | ||
| > * Swim Lessons (Program Subcategory Page, manually entered) | ||
| > * Youth Group Swim Lessons (Activity, mapped from CRM or custom automation) | ||
| > * Stage 3 (Class, mapped from CRM) | ||
| > * Monday/Wednesday/Friday 9:30-10 a.m. at Franklin Family YMCA (Session, mapped from CRM) | ||
| > | ||
| >*Note: This is an example only. Depending on your CRM and any customizations you make, your setup for Swim Lessons or any program may look different that the example listed above.* | ||
|
|
||
| ## Activity | ||
| Often used as the top-level filter in Activity Finder and Repeat Schedules, Activity consists of three fields: | ||
|
|
||
| * **Title**: The name of the Activity (and the filter in Activity Finder). | ||
| * **Program subcategory**: An *entity reference* to or tag for a [Program Subcategory](https://community.openymca.org/t/program-subcategory-content-types-open-y-user-docs/692). Maps the Activity to higher-levels of user-entered content. | ||
| ***Description:** A description for the Activity. Usually pulled from a description in a CRM through an API. | ||
|
|
||
| ## Class | ||
| A narrower selection of Program Offerings. Not an individual instance, but a smaller selection of instances. | ||
|
|
||
| Classes have three ields that map into Activity Finder and Repeat Schedules: a *description*, a *title* and *entity reference/tag* to an Activity. | ||
|
|
||
| > Class also contains Areas for content editors to add paragraphs; however, depending on how your CRM and the number of programs your Y runs, it may not be practical use these fields. | ||
| ## Session | ||
| An individual program offering. Contains fields for pricing, session date/time, instructor, ages and a registration link. This are the individual rows/instances in Repeat Schedules and [Activity Finder](https://community.openymca.org/t/activity-finder-activity-finder-search-paragraphs-open-y-user-docs/702). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,47 @@ | ||
| --- | ||
| title: Alert | ||
| --- | ||
| --- | ||
|
|
||
| > Alerts display timely information in a thin banner across your site, just below the header or above the footer. | ||
|  | ||
|
|
||
| Unlike most content types in Open Y, you don't use Alert to create pages. Instead, Alerts display as a *rendered entity* or a section of content on other pages. | ||
|
|
||
| Alerts also don't use paragraphs. By design, the layout of Alerts are rigid; however, text editor and the the color options listed below allow content editors some flexibility. | ||
|
|
||
| ## When Should You Use an Alert? | ||
| * Timely updates for centers, such as when your hours change or facilities close. | ||
| * Marketing promotions, such as for membership campaigns or even promotions. | ||
|
|
||
| ## How to Use an Alert | ||
| Click on "Content" from your admin toolbar, and then click on the blue "Add Content" button." Select "Alert" on the next page. | ||
|
|
||
| * **Title**: Displays as the headline for your alert. | ||
|
|
||
| * **Description**: The main body of your alert. Sentences should be short and minimally styled in this section. Uses [the Open Y Text Editor](https://community.openymca.org/c/Resources-and-training-for-content-editors/Learn-how-to-use-the-basic-text-editing-functions-available-to-content-editors). | ||
|
|
||
| * **Color Fields**: These three dropdown fields control different aspects of color in your alert. All three dropdowns reference the [the Open Y color vocabulary](http://#). | ||
|
|
||
| * ***Background Color***: The color of your alert. | ||
| * ***Text Color***: Stick to using either black or white for accessibility. | ||
| * ***Icon Color***: Changes the appearance of the icon to the left of the title. | ||
|
|
||
| * **Link**: Adds a button with a call to action to the alert on the right. Button color defaults to black. [Learn more about the link field ⇒](http://#) | ||
|
|
||
| * **Placement**: Choose "Header" to show your alert above your main content or "Footer" to show below your main content. | ||
|
|
||
|  | ||
|
|
||
| * **Visibility pages**: This is where you control where the alert displays on your site. In the large text field, you write the relative path of the pages where you want this to appear or not appear. Enter each path on a new line. | ||
|
|
||
| You also have the option to use an asterisk character `*` as a wildcard so you don't have to enter in a large number of relative paths. For example, if you wanted to add an alert to a `/health-and-fitness` section, you would enter `/health-and-fitness*` in the text area. | ||
|
|
||
|  | ||
|
|
||
| > **What is a relative path?** | ||
| > A *relative path* is the part of your url after your *domain name.* | ||
| > | ||
| > At https://openy.org/community, for example, the *domain name* is **`openy.org`**, while the *relative path* is **`/community`**. | ||
| Using the **Alert visibility state** radio buttons at the bottom, you can either show or hide your alert from the page paths listed in the text area above. |
69 changes: 68 additions & 1 deletion
69
content/en/docs/user-documentation/content-types/blog-post.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,70 @@ | ||
| --- | ||
| title: Blog Post | ||
| --- | ||
| --- | ||
|
|
||
| > Designed for timely content, articles and news pieces tagged with one or more physical locations. | ||
| > | ||
| > *Note: This Content Type is [similar to the News Post content type](https://community.openymca.org/t/news-post-content-types-open-y-user-docs/694).* | ||
|  | ||
|
|
||
| Blog posts in Open Y allow you the flexibility to both create simple posts using only the text editor and more robust layouts with paragraphs. | ||
|
|
||
| ## When Should I Use a Blog Post? | ||
| When you decide to use a blog post [depends greatly on your Association's content strategy](https://www.youtube.com/watch?v=myGNK_qUGDM). However, blog posts are designed so you can post timely pages and list them throughout your site. Examples of blogs may include: | ||
|
|
||
| * Member Stories | ||
| * Workouts and Recipes | ||
| * Updates about a Center/Branch | ||
| * Promotions and Contests | ||
| * Press Releases | ||
|
|
||
| ## How Do I Use a Blog Post? | ||
|
|
||
| There are three fields that appear above the accordion tabs below: | ||
|
|
||
| * **Title**: The name of the blog. Displays in the header area on your blog post and in [the cards that display in a list of blogs](https://community.openymca.org/t/blog-posts-paragraphs-open-y-user-docs/705). | ||
|
|
||
| * **Locations**: An *option select* for you to tag a post with one or more locations (Camp or Branch). Use Ctrl+Click (Windows) or Cmd⌘+Click (Mac) to select multiple locations. | ||
|
|
||
| > Each time you create a new Branch Page or Camp Page it populates into the locations field automatically | ||
| * **Category**: An *entity reference* to [the Blog Category vocabulary](https://community.openymca.org/t/taxonomy-vocabularies-and-terms-website-structure-open-y-user-docs/734). Type in the name of the category and select from the options that appear, or create a new category/term by typing in a new one. | ||
|
|
||
|  | ||
|
|
||
| ### Style | ||
| This dropdown changes the style of the post's card when it appears in a listing format. This dropdown does not affect any layouts on the page. | ||
|
|
||
|  | ||
| **####** Story Card | ||
|   | ||
|
|
||
| **####** Photo Card | ||
|   | ||
|
|
||
| **####** News Card | ||
|  | ||
|
|
||
| **####** Color Card | ||
| When choosing color card, you are presented with two styling options in dropdowns. Both are *entity references* to [the Color vocabulary](https://community.openymca.org/t/taxonomy-vocabularies-and-terms-website-structure-open-y-user-docs/734): | ||
|
|
||
| * **Background color**: Changes the color of the card. | ||
| * **Text color**: Changes the color of the text. It's recommended you only use white or black. | ||
|
|
||
| ### Content Area | ||
| The content area is the main body of your page. You can use the default fields entered below for a simple block post or build a more robust layout using paragraphs. | ||
|
|
||
| * **Image**: Displays above your description and inside a Photo Card. Not required. Uses the [media browser and image field.](https://community.openymca.org/t/video-tutorials-for-images-and-documents/738) | ||
|
|
||
| * **Description**: [Using the Open Y text editor](https://community.openymca.org/t/introduction-text-editor-open-y-user-docs/643), you can enter anything from a brief summary to the entire body of your text. | ||
|   | ||
|
|
||
|
|
||
| ### Sidebar Area | ||
|
|
||
| The sidebar area also allows you embed paragraphs below a section that links to the centers tagged in the post, the categories and a *Related Content field* that allows you to promote other Blog Posts by tagging them with the autocomplete widget. | ||
|
|
||
| ### Layouts | ||
|
|
||
| While you have the option to build layouts in blog posts using paragraphs, all blog posts are strictly two-column layouts. The Content Area displays on the left while the Sidebar Area displays on the right. |
105 changes: 104 additions & 1 deletion
105
content/en/docs/user-documentation/content-types/branch.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,106 @@ | ||
| --- | ||
| title: Branch | ||
| --- | ||
| --- | ||
|
|
||
| **One of the first places members go when they visit a Y website is to their local Y’s page. In Open Y, you create pages for a wellness facility with the Branch content type.** | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ## Collecting Standard Information for Your Branch | ||
|
|
||
| When you create a branch, you create a page for that branch, a card listing on your locations page, and a tag for blogs, sessions, events, membership types and news posts. | ||
|
|
||
| Most of your general information will display in your header. | ||
|
|
||
| Your branch amenities will only display if you add a “Branch Amenities with Icons” paragraph in your bottom or content Area | ||
|
|
||
| --- | ||
| ## Branch Information Fields | ||
| ### General Information | ||
| #### -> Title | ||
| This is the name of your branch, which will display as your page title and the title in the location card. | ||
|
|
||
| There is no separate field for the full name of your facility (e.g., Downtown Nashville YMCA Burkholder Center) versus the common name (Downtown YMCA). The best practice would be to use the shorter, more common name for readability. | ||
|
|
||
| #### -> Neighborhood | ||
| An optional reference to specify which neighborhood your Y is located in (e.g., “East Nashville” for the Margaret Maddox YMCA). Start typing and select from the list of neighborhoods that appear. | ||
|
|
||
| To add a new neighborhood, add it to the “Area” vocabulary under Structure > Taxonomy. | ||
|
|
||
| --- | ||
|
|
||
| ### Contact Info | ||
|
|
||
| #### -> Address: | ||
| The physical address of your location. Be sure to include all address fields. | ||
|
|
||
| #### -> Branch coordinates | ||
| This field pins your branch on the locations map. | ||
|
|
||
| > **How to Get Your Branch Coordinates from Google Maps** | ||
| > * Right click on your Y and select “What’s here?” Click on the latitude/longitude number at the bottom of the card. | ||
| > | ||
| >  | ||
| > | ||
| > * Below the headline, copy the first number (the non-negative number) into the latitude field. Copy the second number (the negative number) into the longitude field. | ||
| > | ||
| >  | ||
| #### -> Phone/Fax/Email | ||
| The fax is optional, but add the main line for your branch in the phone field. | ||
|
|
||
| Add a main contact email, such as contactmyy@anytownymca.org, rather than the email for an individual staff member. | ||
|
|
||
| #### -> Directions | ||
| Link to your Google Places. Add “Get Directions” in the Link Text section. | ||
|
|
||
| #### -> Branch Hours | ||
| Add the main hours for your facility. Use the 7am-5pm format to save space. Displays in the header and on the card. | ||
|
|
||
| > **Note** - Some Ys have set up the branch hours field to include holiday hours, as well as hours for multiple parts of your facility. This is an advanced feature; talk to your agency partner if you would like this. | ||
| --- | ||
|
|
||
| ### Header Area | ||
| There is no image field for the Branch content type, so you will need to add one of the following paragraphs to add an image and title at the top of your page: | ||
|
|
||
| * [Banner](https://community.openymca.org/t/banner-open-y-paragraphs-user-documentation/665) | ||
| * [Small Banner](https://community.openymca.org/t/small-banner-paragraphs-open-y-user-docs/725) | ||
| * [Gallery](https://community.openymca.org/t/gallery-paragraphs-open-y-user-docs/715) | ||
|
|
||
| ### Content Area | ||
|
|
||
| The Branch Content Type only has one layout option—one column—and no description field. Add in almost any paragraph you want into the body of you page. | ||
|
|
||
| The following paragraph types integrate directly with Branch: | ||
|
|
||
| * [Latest Blog Posts (Branch)](https://community.openymca.org/t/latest-blog-posts-including-camp-branch-paragraphs-open-y-user-docs/717) | ||
| * [Latest News Posts (Branch)](https://community.openymca.org/t/latest-news-branch-including-camp-branch-paragraphs-open-y-user-docs/718) | ||
| * Branch Amenities with Icons (see Branch Amenities below) | ||
|
|
||
| ### Bottom Area | ||
| Use the bottom area for anchoring elements on your page. The following paragraphs are great for this area: | ||
|
|
||
| * [Small Banner](https://community.openymca.org/t/small-banner-paragraphs-open-y-user-docs/725) | ||
| * [Gallery](https://community.openymca.org/t/gallery-paragraphs-open-y-user-docs/715) | ||
| * [Webform](https://community.openymca.org/t/webform-paragraph-open-y-user-docs/729) | ||
| * [Limited Time Offer](https://community.openymca.org/t/limited-time-offer-paragraphs-open-y-user-docs/719) | ||
|
|
||
| --- | ||
| ### Branch Amenities | ||
|
|
||
| Type in and select which amenities are available at your branch using the autocomplete field. | ||
|
|
||
|  | ||
|
|
||
| If you embed a Branch Amenities with Icons paragraph on your page, the amenities will display in your content. The Amenities will also serve as filters for branches on your locations page. | ||
|
|
||
| If you don't see an option available or would like to rename a branch amenity, go to Structure > Taxonomy > Amenities. | ||
|
|
||
| **####** Closed Amenities | ||
| Ys with Open Y 2.5 or later can tag amenities at a branch that have closed. Content editors will see a "Closed Amenities" field. | ||
|
|
||
|   |
Oops, something went wrong.