Add links to the model term page #5938
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
content
3 tasks
mirnawong1
approved these changes
Aug 22, 2024
There was a problem hiding this comment.
hey @alison985 , hope you're doing well and thanks so much for this input! great pr and this makes it much clearer and provides good resources to users. really appreciate you opening this up! i made a small tweak and am approving this for you! thank you again!
matthewshaver
added a commit
that referenced
this pull request
Aug 29, 2024
## What are you changing in this pull request and why? In #5938 I said that the style guide doc link in the pull request template didn't work and I'd open a separate pull request. I also couldn't find the style guide on the docs site under [contributing](https://docs.getdbt.com/community/contribute), so I was looking in the wrong place. When I went to edit this file the links worked. 😆 at myself. I must have copied it wrong the first time. However, the template did seem pieced together instead of cohesive, so I'm here proposing some changes. * Cut the line break that didn't match the method of the rest of the document. * Moved the checklist items that are relevant to al pull requests to the top of the list. I think this will help contributors understand which checklist items apply to them. Along with the other changes bulleted below it should make it so we don't have to read the entire list of items when submitting each PR in order to make sure we don't skip one. * Removed the duplicate checklist item about versioning under the pre-release version checklist items. * Changed the top line of each optional set of checklist items to be easy to find and clear about when to use it. * Changed the phrasing of the statements to make them more like certifications you've done the required activity. This matches the dbt-core [pull request template](https://github.com/dbt-labs/dbt-core/blob/main/.github/pull_request_template.md). I did not: * Add a note or reference to a Code of Conduct. I think COCs are vital, at the same time it may be something you don't want to add to this particular template to keep the "barriers" to doc contribution low. * Attempt to cross-link the Docs contribution guidelines with the dbt-docs style guide. ## Checklist - [x] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. - [x] For [docs versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning), review how to [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content). - [x] Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch." Co-authored-by: Matt Shaver <[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.
What are you changing in this pull request and why?
The "Model" term page in the glossary is pretty short and doesn't help lead anyone to next steps. I'm proposing adding these links to help newer contributors. Because there are so many search results for the word "model" this may be more important on this page than most Term pages.
Checklist