Skip to content
Permalink
Browse files

Documentation Updates

* [#419] added instructions on Facebook Login configuration
* [#421] added instructions to rebuild search indexes when setting up Habitat
* [#425] added clearer language to README regarding support
  • Loading branch information...
nickwesselman committed Jul 9, 2018
1 parent 6c36bbe commit 89e0090f2a8ec1fe32fdc52f3d926089851813cc
Showing with 29 additions and 1 deletion.
  1. +16 −1 README.md
  2. +13 −0 docs/01-Getting-Started.md
@@ -1,6 +1,6 @@
# Sitecore Habitat

Habitat is an example Sitecore solution built on the [Helix architecture principles](http://helix.sitecore.net). It is designed to show how a Helix-based solution can be architected, and to demonstrate how tooling can be used to accomplish publishing, serialization, and testing. Habitat **is not intended** to be a starter solution, or as a recommendation of tools for your solutions.
Habitat is an example Sitecore solution built on the [Helix architecture principles](http://helix.sitecore.net). It is designed to show how a Helix-based solution can be architected, and to demonstrate how tooling can be used to accomplish publishing, serialization, and testing. Habitat **is not intended** to be a starter solution, or as a recommendation of tools for your solutions.

The architecture and methodology focuses on:

@@ -10,3 +10,18 @@ The architecture and methodology focuses on:

For getting started, please check out the [Documentation](./docs).
For more information on **Helix**, please go to [helix.sitecore.net](http://helix.sitecore.net).


## Is Habitat a starter kit or template solution?

No. You should not clone this repository for the purposes of starting a new Sitecore project. There are other community solutions which can be used as a starter for Helix-based Sitecore implementations. Habitat is intended as a **reference example** of a Helix-based Sitecore implementation.

## Is Habitat supported by Sitecore?

Sitecore maintains the Helix documentation and Habitat example, but Habitat code is not supported by Sitecore Product Support Services. Please do not submit support tickets regarding Habitat.

## How can I get help with Habitat?

For usage questions regarding Habitat installation or code, or questions about Helix, please utilize [Sitecore Stackexchange](https://sitecore.stackexchange.com/) or [#helix-habitat](slack://channel?team=T09SHRBNU&id=C0HNYDJ5V) on [Sitecore Community Slack](https://www.akshaysura.com/2015/10/27/how-to-join-sitecore-slack-community-chat/).

You can use GitHub to submit [bug reports](https://github.com/Sitecore/Habitat/issues/new?template=bug_report.md) or [feature requests](https://github.com/Sitecore/Habitat/issues/new?template=feature_request.md) for Habitat. Please do not submit usage questions via GitHub.
@@ -98,6 +98,11 @@ If your Solr environment is not currently running with HTTPS, you can create an
* Switch to "Solution 'Habitat'"
* Run the "default" task

### 3. Rebuild search indexes

1. [Rebuild](https://doc.sitecore.net/sitecore_experience_platform/setting_up_and_maintaining/search_and_indexing/indexing/rebuild_search_indexes) the *sitecore_master_index* and *sitecore_web_index* to deploy the updated schema to Solr and index the deployed content.
* This is required for Habitat search-based features to work properly.

## Additional Information

### Gulp
@@ -136,3 +141,11 @@ For this to work, you need to set the SMTP settings in Sitecore.config.
</mailSettings>
</system.net>
```

### Facebook Login

Habitat demonstrates utilizing the Federated Authentication features of Sitecore to allow login via Facebook account. To enable this functionality:

1. [Register a Facebook App](https://developers.facebook.com/docs/apps/register/) using a Facebook Developer Account.
2. Add the domain under which you are running Habitat to the *App Domains* setting of your Facebook App. By default this is `habitat.dev.local`.
3. Use the *App ID* and *App Secret* from your app settings to populate the `Sitecore.Feature.Accounts.Facebook.AppId` and `Sitecore.Feature.Accounts.Facebook.AppSecret` settings, by default found in `Feature\Accounts\code\App_Config\Include\Feature\Feature.Accounts.config`.

0 comments on commit 89e0090

Please sign in to comment.
You can’t perform that action at this time.