diff --git a/docs/administrator-documentation/moderne-platform/how-to-guides/agent-configuration/configure-agent-files-service.md b/docs/administrator-documentation/moderne-platform/how-to-guides/agent-configuration/configure-agent-files-service.md index dbf7cc24..fffeaa6f 100644 --- a/docs/administrator-documentation/moderne-platform/how-to-guides/agent-configuration/configure-agent-files-service.md +++ b/docs/administrator-documentation/moderne-platform/how-to-guides/agent-configuration/configure-agent-files-service.md @@ -6,6 +6,7 @@ import TabItem from '@theme/TabItem'; In order for Moderne to obtain information about your organizational structure, you will need to create some configuration files and direct the Moderne agent to said files. This guide will explain how to do both of those things. ## repos.csv + This is a required file, which outlines the repositories and the organizations which they are associated with. When provided your organization details, they must be provided in a CSV file with the following format: @@ -27,6 +28,7 @@ The above example would be used in Moderne DX to generate an organizational list To generate this `repos.csv`, we recommend using "[repo fetchers](https://github.com/moderneinc/repository-fetchers)". ## commitOptions.txt + This is an optional file, which allows for custom commit options for individual repositories. When no commit options are provided for a specific repositories we will use the default commit options which are specified in that [agent configuration](agent-variables.md#all-agent-configuration-variables) or all commit options if no default are provided. If you want to provide specific commit options for specific repositories, these can be provided in a text file with the following format: ```text @@ -35,6 +37,7 @@ My_Organzation_ID_2=Branch,Direct,PullRequest ``` ## idMapping.txt + This is an optional file, which set an organization name. By default an organization name is the same as its ID. These can be overwritten by provided a text file with the following format: ```text @@ -43,10 +46,12 @@ My_Organzation_ID_2=My_Organzation_Name_2 ``` ## devCenter.json + This is an optional file, which is used to generate the DevCenter. For more details about configuring your DevCenter please reference this [guide](../dev-center.md#step-3-create-and-configure-the-devcenter). The provided devCenter.json should follow the structure of this [file](https://github.com/moderneinc/moderne-organizations/blob/main/src/main/resources/devcenter.json). ## Agent Configurations +