Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): clear up source configs #7720

Merged
merged 8 commits into from
Apr 4, 2023

Conversation

hsheth2
Copy link
Collaborator

@hsheth2 hsheth2 commented Mar 30, 2023

Compare current vs new

Source config presentation:

  1. Remove the "collapse" section around configs so that it's more clear that they horizontally scroll.
  2. Merge the type into the field name column, and merge the default into the description column. s/o to Brittanie for the design inspiration on this
  3. Ensure that the table does not ever need to scroll horizontally.
  4. Change the "required if parent set" text to be shown on hover rather than polluting the table.

Source config bug fixes:

  1. Fix a bug where basically every field was marked as required.
  2. Fix our JSONSchema parsing so that default values of None or False are still shown in the "Default" column.

Other tweaks

  • Hide the "questions" section from the sidebar.
  • Don't display the "Module snowflake" thing if there's only one source for a given platform.
  • Rename the elasticsearch example recipe so that it actually appears in the docs.

Feedback:

  • Support collapsing nested fields
  • Allow linking directly to a specific config property
  • Format the default values so they stand out a bit more

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

1. Removes the "collapse" section around configs so that it's more clear
   that they horizontally scroll.
2. Change the required / required if parent set details to be shown on
   hover rather than polluting the table.
3. Fix a bug where basically every field was marked as required.
4. Fix our JSONSchema parsing so that default values of `None` or `False` are still
   shown in the "Default" column.
@github-actions github-actions bot added the ingestion PR or Issue related to the ingestion of metadata label Mar 30, 2023
Copy link
Collaborator

@mayurinehate mayurinehate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. This is wonderful.

@anshbansal anshbansal merged commit 82dc2b6 into datahub-project:master Apr 4, 2023
@hsheth2 hsheth2 deleted the docs-table branch February 14, 2024 05:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ingestion PR or Issue related to the ingestion of metadata
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants