Docs improvements #115
Merged
Docs improvements #115
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
graciegoheen
commented
Aug 17, 2023
graciegoheen
commented
Aug 18, 2023
graciegoheen
commented
Aug 18, 2023
graciegoheen
commented
Aug 18, 2023
graciegoheen
commented
Aug 21, 2023
dave-connors-3
approved these changes
Aug 28, 2023
graciegoheen
commented
Aug 29, 2023
graciegoheen
commented
Aug 29, 2023
…nto docs_improvements
Co-authored-by: dave-connors-3 <[email protected]>
graciegoheen
commented
Aug 29, 2023
| # optionally use the add-version operation to add a new version to a model | ||
| dbt-meshify operation add-version -s fct_orders | ||
| ``` | ||
| ## What dbt-meshify does not handle |
There was a problem hiding this comment.
@dave-connors-3 @nicholasyager would love to get your thoughts on if anything else should be called out here!
There was a problem hiding this comment.
🤔 Some low risk thoughts
splitdoesn't copy over all project files, so there may be documentation that's not copied over (like markdown files).- Now that I'm thinking about it, does split copy over files with docblocks?
groupandcreate-groupwill update existing groups already defined in yml.
There was a problem hiding this comment.
What would be the manual checks for these?
- look through markdown files and see if there's any documentation you want to manually bring over (opened a new issue to check about doc blocks Check if split command copies over files with doc blocks #158)
- ??
|
Note to self: should update the size of some of these images (some are giant) |
There was a problem hiding this comment.
@graciegoheen This documentation is WAAAAAY better than what currently exists. I've added a couple of recommendations and followed up on threads. Otherwise, no issues as far as I can see!
| # optionally use the add-version operation to add a new version to a model | ||
| dbt-meshify operation add-version -s fct_orders | ||
| ``` | ||
| ## What dbt-meshify does not handle |
There was a problem hiding this comment.
🤔 Some low risk thoughts
splitdoesn't copy over all project files, so there may be documentation that's not copied over (like markdown files).- Now that I'm thinking about it, does split copy over files with docblocks?
groupandcreate-groupwill update existing groups already defined in yml.
Co-authored-by: Nicholas A. Yager <[email protected]>
Co-authored-by: dave-connors-3 <[email protected]>
Co-authored-by: Nicholas A. Yager <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ran into a few bugs while I was creating these docs. Will need to update the docs one the bugs are resolved.