Documentation is extremely poor sometimes

[usmanovbf]

Describe the bug
I've noticed that certain configuration properties for Ingestion recipes are not comprehensively described, presenting gaps and potential misunderstandings. Consequently, I find myself seeking clarification through community channels such as Slack to understand the proper usage of these parameters. Ideally, I would prefer to rely solely on the documentation, without needing to engage the Datahub Engineers directly.

To Reproduce
Steps to reproduce the behavior:

1. A number of documentation pages feature incomplete descriptions and are missing practical examples, especially for complex parameters. For instance, please refer to the Tableau source configuration details.
2. There is unclear guidance on how to effectively utilize configurations like lineage_overrides and platform_instance_map.

Expected behavior
I would appreciate it if the documentation could include well-explained parameters along with examples, similar to the standard set by AWS Docs, which provide detailed explanations, practical examples, and noted restrictions (e.g., Amazon S3 Object Keys Guide and Amazon S3 API CreateBucket).

Suggestion for Improvement

Could you all possibly initiate an internal effort to enhance and refine our documentation, please? This would significantly benefit users by providing clearer guidance and reducing the need for direct inquiries. It will increase customer satisfaction, because even not only me but my colleagues also confess on how the documentation is not suitable for them sometimes.

[github-actions]

This issue is stale because it has been open for 30 days with no activity. If you believe this is still an issue on the latest DataHub release please leave a comment with the version that you tested it with. If this is a question/discussion please head to https://slack.datahubproject.io. For feature requests please use https://feature-requests.datahubproject.io

[usmanovbf]

Actual