diff --git a/docs/best-practices.md b/docs/best-practices.md index 58cecbe44e241c4bc8b8f58542e19b38cd20a782..e29a71ddb3c74625a9555c6e0e87fbdc3b677569 100644 --- a/docs/best-practices.md +++ b/docs/best-practices.md @@ -2,7 +2,7 @@ Here are some recommended best practices for designing integrations in IICS. -* [Working In a Shared Environment](best-practices/shared-enviornment.md) +* [Working In a Shared Environment](best-practices/shared-environment.md) * [Naming Conventions](best-practices/naming.md) * [AWS S3 as a Flat file alternative](best-practices/flat-file-alternative.md) * [Secure Agents](best-practices/secure-agent.md) diff --git a/docs/best-practices/naming.md b/docs/best-practices/naming.md index 9e2cbbee26e0747ac73fce6834ac9b87f97b54b7..fdf0a0d7b706e1b04038179583dc0495418ae49e 100644 --- a/docs/best-practices/naming.md +++ b/docs/best-practices/naming.md @@ -13,7 +13,7 @@ The following naming conventions are recommended for various IICS assets. These | Mappings | <ul><li>Use underscore to separate words</li><li>Use consistent naming for different type of mappings</li><li>Name structure:<ul><li>Mapping with single source: `M_<SOURCE>_<TARGET>_<NAME>_<VERSION>`</li><li>Mapping with multiple sources: `M_<SOURCE>_<ENTITY>_to_<TARGET>_<NAME>_<VERSION>`</li></ul></li></ul>|<ul>`M_CDI_Accounts_FF_incremental`</ul><ul>`M_CDI_Accounts_Contacts_to_SFDC`</ul>| | Task Flows | <ul><li>Use underscore to separate words</li><li>Use consistent and readable(mix case) naming</li><li>Name structure: `TF_<NAME>_<VERSION>`</li></ul>|<ul>`TF_CDI_Acount_Contacts_to_SFDC`</ul><ul>`TF_Hierarchy_Change_Processing`</ul>| | Schedulers | <ul><li>Use underscore to separate words</li><li>Use consistent and readable(mix case) naming</li><li>Name structure: `Schedule_<TIMEZONE>_<Frequency>_<TIME>`</li></ul>|<ul>`Schedule_Five_Minutes`</ul> <ul>`Schedule_PST_Daily_11PM`</ul>| -| Project/Folders | <ul><li>See [Projects Namespace](./shared-enviornment.md)</li><li>Name structure: `{group name} - {project name}`</li></ul>|<ul>`DoIT-AIS-Enterprise-Integration - Salesforce Integrations`</ul>| +| Project/Folders | <ul><li>See [Projects Namespace](./shared-environment.md)</li><li>Name structure: `{group name} - {project name}`</li></ul>|<ul>`DoIT-AIS-Enterprise-Integration - Salesforce Integrations`</ul>| Reference: * [Informatica Cloud Naming Conventions](https://github.com/jbrazda/Informatica/blob/master/Guides/InformaticaCloud/naming_conventions.md) \ No newline at end of file diff --git a/docs/best-practices/shared-enviornment.md b/docs/best-practices/shared-environment.md similarity index 100% rename from docs/best-practices/shared-enviornment.md rename to docs/best-practices/shared-environment.md diff --git a/docs/howto.md b/docs/howto.md index 5be71b85cccfae331a59a0df361305f56c4b0513..dcf3a6029763830bab24bdc150bf70dfc5d51471 100644 --- a/docs/howto.md +++ b/docs/howto.md @@ -37,7 +37,7 @@ DoIT EI uses Manifest groups to give teams access to the UW-Madison IICS environ * [ ] Once you have added the required members please email doit-integration-platform@office365.wisc.edu with the Manifest group path. Example: uw:org:ais:DoIT-AIS-Enterprise-Integration-IICS. DoIT EI will notify you when we have provided necessary access to the Manifest group. We will also provide you with an IICS User Group name which you will use to restrict access to your team's assets in IICS: - [Use user groups to control access](best-practices.md#use-user-groups-to-control-access) + [Use user groups to control access](./best-practices/shared-environment.md#use-user-groups-to-control-access) * [ ] Each member of the Manifest group will need to log in to each IICS environment (e.g. test and production) using their UW-Madison NetId, which will create an IICS user account for them automatically.