Using the DocumentationConfiguration Object

SitecoreDXG supports being passed a DocumentationConfiguration object as a property of the JSON object stored in the OPTIONS_FILE_PATH passed to the middleman. This object allows users to add extra information to the documentation that they plan to generate. 
By default, this object supports the following properties:
1.DocumentationTitle
2.CommitAuthor
3.CommitHash
4.CommitLink
5.DeployLink
6.ProjectName
7.EnvironmentName
An example DocumenationConfiguration object is shown below:
1
{
2
    "DocumentationConfiguration": {
3
        "DocumentationTitle": "Foo Corp Sitecore Solution Documentation",
4
        "ProjectName": "Foo Corp .COM",
5
        "EnvironmentName": "UAT",
6
        "CommitAuthor": "Zachary Kniebel",
7
        "CommitHash": "0FE1D344",
8
        "CommitLink": "http://mygit.com/repo/myrepo/commits/0FE1D344",
9
        "DeployLink": "http://mydocs.com/foo/bar"
10
    }
11
}
Copied!

Using the Default RabbitMQ Middleman and Trigger

Using the Provided AWS S3 Deploy Completion Handler

Last modified 3yr ago

Copy link