Documentation

Documentation Index

The two listed documentation topics are designed to instruct on how to properly clone and prepare a duplicate of this site to be used to create a brand new RIC website and start writing articles for that website. This documentation does not include any instructions on migrating content from an existing site or on procedures for managing domain names.

There are many useful articles and video documentation found at sitefarm.ucdavis.edu.

Clone This Site to Start a New RIC

In short, a person with access to Acquia Site Factory needs to log into their account and create a clone of the web property called "riccoalition". After that there is a little bit of content cleanup to be done before getting started.

If you do not have access to Site Factory or know the proper person to contact for help creating a new RIC site, please email [email protected] for help.

Clone "riccoalition"

After logging in use the filter results interface to find the "riccoalition" property.

Site Factory filter

 

It should look like this.

RIC Coalition Site for Duplication
RIC Coalition Site for Duplication

Use the drop down next to the "Log In" text to select the clone command, "Duplicate Site".

Duplicate Site
Duplicate Site

This will bring you to a configuration screen for your Duplicate Site. 

Duplicate Site Config
Duplicate Site Config

In the type field enter the name of your new RIC site. This is an internal address and will not be the live URL. Make sure that "Full site clone" is selected and then click the "Duplicate Site" button in the lower right.

After starting the process you should see a confirmation that the site is being created.

Duplication confirmation

 

Wait for the email. It should look something like:

Confirmation Email

 

You can then go back to Site Factory and search for your new site name and login.

Login Button

Remove the Sample Content

Change Default Mailing Address

Once logged in we need to clean up a few things. First we are going to go into the Basic site settings and change the websites default mailing address.

Drupal Admin Menu - Site Settings

 

Once in the Basic site settings change the "Email address" field to an appropriate email address. If left as the default of "[email protected]" then automated emails from your site will go to that email address.

Note: This email address will be the "From" address in automated emails sent during registration and new password requests, and other notifications. (Use an address ending in your site's domain to help prevent this email being flagged as spam.)

Be sure to save your work.

Update Feedback Form Recipients

Next we will be updating the email address for the websites Feedback form. Go to Structure -> Contact forms -> Website Feedback. 

Feedback form from menu

Replace the email address in the recipients field with an appropriate email address for anonymous users to contact the site owner(s). Save the form.

Info: This form is found via link in the website footer that says "Questions or comments?".

Remove Warning on Home Page

Next we are going to remove the warning on the home page that was placed to prevent users from accidentally adding content to the "riccoalition" clonable website.

Navigate to the home page of your website and click on the button for "Layout"

Click the "Delete section" button in the upper right of Section One. Then "Save Layout".

Delete Sample Content

Sample content is no longer needed after you have clicked around and understand how things are tied together, and if you don't delete it, it may cause SEO issues down the road, so please clear this out as soon as it is no longer needed.

Once you add your content the home page and crop views should start working again as advertised.

Note: You may want to wait till your content is in to delete the demo content just so you can see how things are working.

Content

Go to Content, https://yoursite.ucdavis.edu/admin/content,  and delete all the content except for the home page.

Media

After deleting the content that had this media in it, this is less important, but is good to clean out for future editors.

Go to Media, https://yoursite.ucdavis.edu//admin/content/media

You can filter by the Category "Documentation" and delete all the screenshots from this documentation page by checking all the boxes and choosing "Delete media" from the toolbar at the bottom of the page.

You can filter by the Category "Sample" and delete all the screenshots from this documentation page by checking all the boxes and choosing "Delete media" from the toolbar at the bottom of the page.

Taxonomy

Delete the terms in the following vocabs.

Report Type: Go to https://yoursite.ucdavis.edu/admin/structure/taxonomy/manage/report/overview and delete the sample report types. Then replace them with your own.

Crop Type: Go to https://yoursite.ucdavis.edu/admin/structure/taxonomy/manage/crop_type/overview and delete the Crop Types. Then replace them with your own.

Tags: Go to https://yoursite.ucdavis.edu/admin/structure/taxonomy/manage/sf_tags/overview and delete the sample tag.

Year: Go to https://yoursite.ucdavis.edu/admin/structure/taxonomy/manage/year/overview and delete the sample years. Replace them with years to be used with Reports.

Home Page Grid Feature Explained

The home page contains a view called the "Limited Crops Grid". It consists of a maximum of 8 crops with thumbnails above a section that will display any number of additional crops as text only in a 4 column layout.

Crop Grid

To add a crop to the grid area with thumbnails you will need to create a crop, Content -> Add content -> Crop,  with a thumbnail and select the promotion options for "Promoted to front page" and "Featured content". 

promotion

 

To add items to the text link area below the 8 item grid select only the "Promoted to front page" option.

Troubleshooting: If you have an item that isn't showing up in either, check to make sure it is not the 9th item with both "Promoted to front page" and "Feature Content". If so it will be pushed out of the 8 item grid, but not qualify for the display below due to its "Feature Content" status.

Creating a Crop

Crops Explained

 

Crops Consist of the Following Fields

The following fields and relationships are key to making a crop function as designed.

  • Title/Crop Name
    • This is the name of the crop and will be displayed on the Crop page and in all teasers for this crop across the site.
  • Description
    • Click the "Edit Summary" link to provide shortened text to by used for Crop teasers across the site. This will also allow you to exclude any formatting that may be found at the top of the description from the teasers.
    • Formatted description shows at top of Crop page and a shorted excerpt will be derived for teasers across the site if a Summary is not provided.
  • Management Info
    • Create a Basic Page, Content -> Add content -> Basic Page, and begin typing the name of that page into the Management Info field selecting it when the auto complete suggests it from the list.
    • You can add multiple by clicking "Add another item"
  • Resources
    • After saving this crop you can add Resources to it by creating Crop Resources.
    • Resources are populated on this page automatically by creating a Crop Resource and choosing this Title/Crop Name and a Resource Type. Resources will display on this crop page below Management Info and above Featured Resources.
  • Featured Resources
    • After saving this crop you can add Featured Resources to it by creating Crop Resources and checking a box for Featured Resources.
    • Featured resources are populated on this page automatically by creating a Crop Resource and choosing this Title/Crop Name and marking it as a Featured resource. Resources that have the checkbox for Featured checked will be excluded from the resources list above and instead listed here with a link to one of the following in this order based on availability; 1. The Resource link, 2. The Resource PDF, and 3. Link to the resource page.
  • Primary Media
    • Add an image to be used at the top of the Crop page.
    • Image will be scaled and cropped to a ratio of 100:23.
    • Ideal upload size is 2000x460px.
  • Crop Icon
    • Add an image to be used in the Crop page title and on the home page and crop page.
    • Images are scaled and cropped to 1:1.
    • Ideal upload size is 200x200px.
  • New and Exciting Articles
    • Populate the Primary Crop Tag field on this Crop and save it, then you can associate an article.
    • Related articles are populated on this page automatically by creating an article and tagging it with the Primary Crop Tag entered for this crop. Find this field in the "Categorizing" drop down of the sidebar.
  • Related Photo Gallery (In "Related Content" found in Sidebar)
    • Create a Photo Gallery, Content -> Add content -> Photo Gallery, and choose it from the "Related Photo Gallery" field by beginning to type the title and choosing it from the autocomplete suggestions.
  • Primary Crop Tags (In "Categorizing" found in Sidebar)
    • Fabricate a primary crop tag that can be used to associate articles. If your crop is called Apple, I would suggest giving it a primary crop tag of Apple.
  • Promoted to Front Page (In "Promotion options" found in Sidebar)
    • Check the box for "Promoted to front page" and this crop will appear as a text link in the feature on the home page that teases crops.
  • Feature Content (In "Promotion options" found in Sidebar)
    • Check this box along with the one for "Promoted to front page" to have this crop appear as a linked Crop Icon/Title at the top of the Crop feature found on the home page.

Creating Crop Resources

Crop Resources Diagram

 

Resources are populated on Crop pages automatically by creating a Crop Resource and choosing the Title/Crop Name and a Resource Type. Resources will display on this crop page below Management Info and above Featured Resources as a link to the resource type.

  • Resource Title (Required)
  • Body
  • Crop (Required)
    • Choose the crop that you would like this resource to appear on
  • Resource Type (Required)
    • Choose the type of resource this is
  • Resource Link
    • Link this resource to an internal/external link
  • Resource PDF
    • Link this resource to a PDF file

You can add/edit resource types at Structure -> Taxonomy -> Crop Type.

Creating a Research Report

Research Report Explained

 

Create a research report by going to Content -> Add Content -> Research Report.

  • Report Title
  • Box URL
    • ​​​​​​​Link to a resource in Box.com
  • Publication Year (add publication years to Structure -> Taxonomy -> Year)
  • Description
  • Categories (add Report type to Structure -> Taxonomy -> Report Type)
  • Primary Image

Writing Articles

Please read the SiteFarm Documentation on Creating an article.

If you would like to list an article as a "New and Exciting Articles" on a crop page. Assign a "Primary Crop Tag" to a Crop, then create an article and choose the matching term in the Tags field. It will then show up on that crop page.