Skip to content

Documentation is extremely poor sometimes #10375

@usmanovbf

Description

@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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions