Feature Overview (aka. Goal Summary)

This feature aims to improve the experience around authentication and catalog providers by enhancing documentation (for better clarity, structure, and accuracy), error messages, and support processes. The objective is to reduce auth related customer issues, improve troubleshooting, and make the onboarding process smoother

Goals (aka. expected user outcomes)

Reduce number of support tickets and make it easier to debug support issues relating to authentication and catalog providers

• Reduce the number of support tickets related to misconfigured or misunderstood authentication and catalog providers
• Allow support team to debug/address customer issues more efficiently
• Make onboarding process smoother for customers

Requirements (aka. Acceptance Criteria):

4 main tasks in total:

• Work with docs team to improve Product documentation
  • Ensure accuracy and readability (tone and word choice)
  • Add high-level overviews explaining how auth and catalog ingesters work together
• Compile strategies to triage customer issues and common issues for the support team
  • Work with support team for knowledge transfer
  • This would be an on-going effort that extends beyond the 1.7 release
• (Out of scope) Surface better error messages in auth and catalog providers
  • Ensure no sensitive information is exposed
• Config linter spike

Out of Scope (Optional)

High-level list of items that are out of scope.

• full implementation of config linter, only scope out the feature and determine priority

Customer Considerations (Optional)

There are a number of support tickets that could be avoided with clearer documentation. It would also lead to a less painful onboarding experience.

Documentation Considerations

A large part of this feature itself is improving documentation (see requirements)