SitecoreDXG Documention
  • SitecoreDXG: The Documentation Experience Generator
  • Overview
    • SitecoreDXG: The Documentation Experience Generator
    • Comparison with SitecoreUML
    • CI/CD Integration
    • Helix Dependency Validation
  • Getting Started
    • Compatibility and System Requirements
    • Installing SitecoreDXG
      • General Installation
        • 1. Install the SitecoreDXG Generation Service
        • 2. Install RabbitMQ
        • 3. Install the SitecoreUML Service for Sitecore
        • 4. (Optional) Configure the Documentation Configuration Item for your Solution
        • 5. Install the Default RabbitMQ Middleman in a Custom Location
        • 6. (Optional) Integrate SitecoreDXG into your CI/CD Pipeline
      • Developer Installation
        • 1. Install the SitecoreDXG Generation Service for Developers
        • 2. Install RabbitMQ for Developers
        • 3. Install the SitecoreUML Service for Sitecore for Developers
        • 4. (Optional) Configure the Documentation Configuration Item for your Solution
        • 5. (Optional) Install the Default RabbitMQ Middleman for Developers
        • 6. (Optional) Integrate SitecoreDXG into your CI/CD Pipeline for Developers
    • Upgrading and Downgrading
    • Downloads
    • Using SitecoreDXG
      • Using the Default RabbitMQ Middleman and Trigger
        • Using the DocumentationConfiguration Object
      • Using the Provided AWS S3 Deploy Completion Handler
      • Using the Provided Azure Blob Storage Deploy Completion Handler
  • Architecture
    • Architecture Overview
    • Roles
      • Role Combinations
    • Components
    • Plugins
      • Trigger Plugins
      • Completion Handler Plugins
    • Middlemen
    • Understanding the Default RabbitMQ Middleman and Trigger
  • How To
    • CI/CD Integration
      • Integrating SitecoreDXG into your CI/CD Pipeline
      • Integrating the Default TeamCity RabbitMQ Meta-Runner
    • Creating a Custom Trigger
      • Executing Documentation Generation
      • Executing Meta-Data JSON Generation
    • Slack and Microsoft Teams Integration
      • Integrating with Slack via Webhooks
      • Integrating with Microsoft Teams via Webhooks
    • Creating a Custom Completion Handler
    • Creating a Custom Middleman
    • Viewing Helix Validation Errors
  • About the Generated Documentation
    • Overview
    • Models
      • Template Model
      • Template Field Model
      • Template Folder Model
      • Parent-Child Relationships of Models
      • Inheritance Relationship Model
      • Dependency Relationship Model
    • Views
      • Template View
      • Template Field View
      • Template Folder View
      • Parent-Child Relationship View
      • Inheritance Relationship View
      • Dependency Relationship View
    • Diagrams
      • SitecoreUML Syntax
      • Templates Diagram
      • Template Folders Diagram
      • Layer Diagrams
      • Module Diagrams
      • Module Templates Diagrams
    • Samples
Powered by GitBook
On this page
  • Configuring the Documentation Configuration Item
  • Why Do I have to Select the Module Folders?
  • Side-note
  1. Getting Started
  2. Installing SitecoreDXG
  3. General Installation

4. (Optional) Configure the Documentation Configuration Item for your Solution

Previous3. Install the SitecoreUML Service for SitecoreNext5. Install the Default RabbitMQ Middleman in a Custom Location

Last updated 6 years ago

Be sure that you have completed the installation of the before proceeding with this step.

The latest version of the includes a new Documentation Configuration item, found at /sitecore/system/Modules/SitecoreUML/Documentation Configuration (by default; you can change this in the SitecoreUML.config), that controls some of the options for how your documentation should be generated. Note that while setting up the Documentation Configuration item is optional, if you do not configure the item then none of the Helix Diagrams will be generated, but note that the item does not need to be published, unless your SitecoreUML Service for Sitecore is configured to retrieve data from the web database.

Configuring the Documentation Configuration Item

Each of the following steps is optional, but recommended:

  1. Provide a title for your documentation, by specifying it in the Documentation Title field.

  2. For each layer, specify the root template folder item in the [Foundation|Feature|Project] Layer Root field.

  3. For each layer, select the module folders that belong to the layer in the [Foundation|Feature|Project] Module Folders field.

    1. Note that module folders are not selected by the system, by default, so if do not select any module folders than no modules will appear in your layers and Helix Diagrams will not be generated for the modules

    2. Note that you may choose to select module group folders as module folders or you may select the individual modules within those module group folders. However, at this time identifying a module as belonging to a module group is not currently supported.

Why Do I have to Select the Module Folders?

SitecoreDXG needs to know the module folders in order to be able to generate the Helix Diagrams. Unfortunately, there is no reliable way to identify module folders, due to the fact that some modules live within module groups.

When the first version of the Helix Diagram features were initially created, they were developed for SitecoreUML and used Regular Expressions in order to determine which paths belonged to module folders. Despite being made user-configurable, this approach proved unreliable for varying architectures, and tedious for users to update. As such, the Regular Expression approach was abandoned for the implementation in SitecoreDXG and replaced with fields for selecting the modules that belong to each layer.

Side-note

It is worth mentioning that while the Documentation Configuration item is included in the SitecoreUML Service for Sitecore, it is currently only used by SitecoreDXG. There are currently plans in place to rewrite the SitecoreUML Service for Sitecore to be a part of SitecoreDXG and to update SitecoreUML to call SitecoreDXG for reverse engineering and deployment needs.

SitecoreUML Service for Sitecore
SitecoreUML Service for Sitecore