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

Documentation Standard Updates #13

Merged
merged 2 commits into from
Sep 5, 2024

Conversation

fivetran-joemarkiewicz
Copy link
Collaborator

@fivetran-joemarkiewicz fivetran-joemarkiewicz commented Aug 28, 2024

This pull request was created automatically 🎉:

  • Ensure .github/ files have been properly updated (templates are updated and auto releaser is included)
  • Confirm all appropriate end models are included in the .quickstart/quickstart.yml file as public_models (only for transform repos)
  • Verify the README has made all necessary updates:
    • Removal of emojis
    • Replacing exclamation points with periods in sentences
    • Adjusting all headers to ensure only one H1 heading
    • Confirming a section header is included for Quickstart UI rendering (only for transform repos)
    • Renaming **model to **table** (only for transform repos)
    • Removal of Fivetran community and office hour resources (if necessary)

search_order: [ 'spark_utils', 'dbt_utils' ]
public_models: [
"servicenow__user_enhanced",

Choose a reason for hiding this comment

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

I don't know if this type of data would work. I've tested it against data that looks like it's on the Slab page.
It should look like this:

public_models:
  servicenow__user_enhanced
  servicenow__change_request_enhanced
  servicenow__user_aggregated
  servicenow__problem_enhanced
  servicenow__activity_summary
  servicenow__task_enhanced
  servicenow__incident_enhanced

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hey @fivetran-markoteodorovic we modeled these public_models sections off of @FedorSafronov PR here.

My understanding is that these should be in a list format. The suggested yml format doesn't represent a list, but the suggested changes in this PR do as well as the following format:

public_models:
  - servicenow__user_enhanced
  - servicenow__change_request_enhanced
  - servicenow__user_aggregated
  - servicenow__problem_enhanced
  - servicenow__activity_summary
  - servicenow__task_enhanced
  - servicenow__incident_enhanced

Choose a reason for hiding this comment

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

@fivetran-markoteodorovic I'm sure that a "bulleted" list as @fivetran-joemarkiewicz wrote it will produce an array and also a json-like notation (property: ['item1', 'item2'] will also produce an array). However, I'm not sure about the notation you mentioned. It may produce a list as well, but I'm not sure.

Choose a reason for hiding this comment

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

Yes, maybe all of theme could be parsed. If Fedors changes passed tests then this will too.

Copy link

@fivetran-catfritz fivetran-catfritz left a comment

Choose a reason for hiding this comment

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

lgtm

@fivetran-catfritz fivetran-catfritz merged commit bec86c5 into main Sep 5, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants