Introduction

This documentation is a combination of:

• articles in OneNote
• articles / tickets in FreshService
• Readme documentation in Azure DevOps repository within Projects
• .Net API references in Forms project
• DevExpress User Documentation

I have run all of the above through docfx to create a website with all the documentation in one place.

Projects:

• Carroll Forms
  • Forms Tool
  • Patch Tool
  • Report Designer
  • Dashboard Designer
  • Carroll Forms Command line tool - Reminders and data refresh
  • Package Import - Import packages from LPR to patch tool
• Scripts
  • Aleks
  • Canvas Data
  • Canvas Vs ODS Report
  • Catalog API
  • DG IT Projects Report
  • Login Lookup
  • Mongoose API
  • Workflow CLI
  • XAVS1 - Advising triage
  • XUSPSC - Address checker

Development Guidelines:

Code Should be checked into a the Azure DevOps repository for version tracking.

• Ideally Commit messages will have the ticket # that prompted the change
• Try not to check in any API keys, passwords, or protected data, this is just for the code
• Each Sub Project should have a readme.md file with information about:
  • What it is, link to Service Request
  • Where it is run and when
  • How to run / Debug
• All changes that are put on servers should be checked into the main branch
  • There should also be notifications turned on the repository to notify the team and allow peer review if needed
  • Ideally we would use pull requests…