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 #23

Merged
merged 5 commits into from
Aug 27, 2024

Conversation

fivetran-joemarkiewicz
Copy link
Collaborator

@fivetran-joemarkiewicz fivetran-joemarkiewicz commented Aug 26, 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 **models to **tables** (only for transform repos)
    • Removal of Fivetran community and office hour resources (if necessary)

Copy link
Contributor

@jlmendgom5TRAN jlmendgom5TRAN left a comment

Choose a reason for hiding this comment

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

Made some edits. Looks good to me!

Copy link
Contributor

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

@fivetran-joemarkiewicz One quick question before I approve, one the be checkboxes say Renaming **models to **tables** (only for transform repos). Is that meant that all instances of "models" should be "tables" or just in the table with the table and its description? For example, L22 calls them models instead of tables.

README.md Outdated Show resolved Hide resolved
@fivetran-joemarkiewicz
Copy link
Collaborator Author

@fivetran-catfritz great callout. We will want to make sure the wording rendered in the Quickstart UI is referring to "tables". So in your callout we will want to make that update. But we can leave the other non UI references as models.

I just made the update. Let me know if you have other questions.

Copy link
Contributor

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

@fivetran-joemarkiewicz thanks for the explanation. lgtm!

@fivetran-joemarkiewicz fivetran-joemarkiewicz merged commit a164a56 into main Aug 27, 2024
8 checks passed
@fivetran-joemarkiewicz fivetran-joemarkiewicz deleted the MagicBot/documentation-updates branch August 27, 2024 18:30
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.

3 participants