Skip to content
This repository has been archived by the owner on May 30, 2022. It is now read-only.

Leveraging the Framework

David San Filippo edited this page Sep 11, 2017 · 1 revision

Introduction

Sitecore Foundation has been rebuilt to leverage Helix Principles. In doing so, it makes it easier to create a custom version of the framework to meet your specific needs. Simple ensure the projects are not needed (either on their own or as a module dependency) and then delete them. This guide gives an overview of the features, their dependencies and their configuration.

Configuration Model

While some modules may be standalone and can be used as is, many features depend on a shared Configuration Model. Every site shares a shared configuration item which can be customized to support certain features through template inheritance. To get started with Sitecore Foundation you can build your own Site Configuration Template and inherit from templates for site features that you wish to support. For convenience we have also provided a sample Site Configuration Item that can be used as is if you are looking to leverage all the Site Features Sitecore Foundation Offers.

Similar to Site Configuration, Sitecore Foundation also supports an inheritance model for Page Specific Features, allowing you create custom page templates that inherit the page templates for features you wish to support. You can look at the Starter Kit and Airspace Sites for example of how page templates can be configured.

Additionally, note that each feature manages it’s own Unicorn Configuration for maintaining templates and content items related to that feature, as well as any Feature specific Configuration patch files. This makes it easier to remove a project without impacting the rest of the solution.

Feature Guide

Over the years, Sitecore Foundation has become a collection of common features implemented on real world projects. That does not mean every feature is useful to every project. Especially when considering performance, we recommend evaluating every feature and turning off what is not needed.

And although Sitecore Foundation is built on the Sitecore API and should not conflict with other modules or frameworks, you should understand what it does so you can understand the impacts of using both modules.

What follows is an overview of the main features of Sitecore Foundation, including a handy table that gives you an overview of the feature.

Module Location Foundation, Feature, Project location of the module.
Recommended Any insights into usefulness, or the impact of removing
Default Is it turned on out of the box with the Starter Kit.
Dependencies Any features that it depends on or that it depends on.
Pipelines Targeted Any pipelines being overridden
Events Targeted Any events being targeted
Site Settings Any Site Settings config templates your Site Configuration template should inherit.
Page Settings Any Page Config Templates your Page templates should inherit
Patch Config Any feature specific config files that should be included if you're not using the default configuration.

There are many configurations possible and many settings that work together to make the solution work. If you're having issues, please post to the Sitecore Developer Accelerators Yammer group for support

https://www.yammer.com/avanade.com/#/threads/inGroup?type=in_group&feedId=4719668&view=all