diff --git a/docs/Menu-Environment-Setup.md b/docs/Menu-Environment-Setup.md deleted file mode 100644 index 02f3456..0000000 --- a/docs/Menu-Environment-Setup.md +++ /dev/null @@ -1,4 +0,0 @@ -# Menu Environment Setup - -## Prerequisites - diff --git a/docs/Module-Installation.md b/docs/Module-Installation.md new file mode 100644 index 0000000..bd8805a --- /dev/null +++ b/docs/Module-Installation.md @@ -0,0 +1,72 @@ +Steps to enable this module in your custom Broadleaf Commerce project. These steps are based on projects that are +similar to the Broadleaf Commerce demo application which contains a core, site, and admin project which are all contained in a "parent project". + +> Note: that the 3.2 version of the demo application already has this menu module included. + +## Steps + +**Step 1.** Add the following to the dependency management section of your **parent** `pom.xml`: +_The parent pom is the one located in the root directory of the Broadleaf Commerce project._ + +```xml + + org.broadleafcommerce + broadleaf-menu + 1.0.0-GA + jar + compile + +``` + +**Step 2.** Pull this dependency into your `core/pom.xml`: + +```xml + + org.broadleafcommerce + broadleaf-menu + +``` + +**Step 3.** Update the `patchConfigLocation` files in your `admin/web.xml` file: + +```xml + classpath:/bl-menu-applicationContext.xml + classpath:/bl-menu-admin-applicationContext.xml +``` +> Note: This line should go before the `classpath:/applicationContext.xml` line + + +**Step 4.** Update the `contextConfigLocation` for `DispatcherServlet` files in your `admin/web.xml` file: + +```xml + classpath:/bl-menu-admin-applicationContext-servlet.xml +``` + +> Note: This line should go just before the `/WEB-INF/applicationContext-servlet-admin.xml` line + + +**Step 5.** Update the `patchConfigLocation` files in your `site/web.xml` file: + +```xml + classpath:/bl-menu-applicationContext.xml +``` +> Note: This line should go before the `classpath:/applicationContext.xml` line + + +## Data Changes + +### Schema Changes + +If you are allowing hibernate to create and modify your tables, this will be done automatically when you restart with the new configuration settings. + +Otherwise, you will need to generate the SQL to customize your Broadleaf implementation. See the [Broadleaf Schema Upgrade Documentation](http://docs.broadleafcommerce.org/core/current/broadleaf-data-upgrade-process) for details. + +### Admin Security Changes + +To create the Menu management section in the Broadleaf admin, you will need to load new permissions. The recommended changes are located in the following files: + +``` +/config/bc/sql/load_menu_admin_security.sql +``` + +> Note: In development, you can automatically load this SQL files by adding it to the blPU.hibernate.hbm2ddl.import\_files property in the development-shared.properties file. diff --git a/docs/_index.md b/docs/_index.md index 7357537..785b89f 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -1,5 +1,12 @@ +## Broadleaf Commerce Community Module + # Menu Module Broadleaf Commerce currently offers a community abstraction Menu module that allows managing Categories and Site Navigation in terms of Menus in the Admin much easier. +## Initial Configuration + +The `1.0.0-GA` version of the Menu module requires Broadleaf version `3.2.0-GA` or later. + +For detailed instructions on how to integrate the content test module into your project, see [[Module Installation]]. diff --git a/docs/_sidebar.md b/docs/_sidebar.md index cf7deb5..03f53ba 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,2 +1,2 @@ - [[Home | .]] -- [[Menu Environment Setup]] \ No newline at end of file +- [[Module Installation]] \ No newline at end of file