Add documentation project #61
Merged
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
britt-allen
approved these changes
Apr 7, 2023
|
Please let me know what else you add/change when this is no longer a draft if not obvious via the GH ui. @ian-r-rose |
Thanks! I just had it as a draft until #57 was merged. Now that it's in, this PR should be easier to review, since the changes in it are only documentation-related. |
britt-allen
reviewed
Apr 7, 2023
| @@ -20,7 +22,7 @@ The process for GitHub-based development is: | |||
| 1. In general, the author of a PR should not approve and merge their own pull request. | |||
| 1. Delete your feature branch, it's in `main` now. | |||
|
|
|||
| ## Authoring a pull request | |||
| ## Considerations when authoring a pull request | |||
|
|
|||
| #### Have Empathy | |||
small punctuation and sentence flow edits
small stylistic and punctuations edits
britt-allen
reviewed
Apr 7, 2023
There was a problem hiding this comment.
This was an excellent read! I learned so much
changed position of "analytics engineering" to practice and position of "analytics engineering"
britt-allen
approved these changes
Apr 7, 2023
Merged
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.
Fixes #58. Depends on #57. See the built version here.
This uses mkdocs-material as a lightweight static site generator. We could also use sphinx, mdbook, docasaurus, etc for this, but mkdocs was exceedingly simple to set up.
Follow-ups would include adding dbt docs to this (which depends on #46)