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.

Sign up for GitHub

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

DMT-2733/updated the user guidance based on ticket-2733 #371

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

DMT-2733/updated the user guidance based on ticket-2733 #371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27979c4
updated the user guidance based on ticket-2733
murad-ali-MoJ Aug 21, 2023
c4f7f19
User guidence updated to inform the model owner update the README
murad-ali-MoJ Aug 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions source/documentation/tools/create-a-derived-table/models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,9 @@ If for some reason it is not possible or reasonable to apply a configuration in

Configurations are prioritised in order of specificity, which is generally the inverse of the order above: an in-file `config()` block takes precedence over properties defied in a `.yaml` property file, which takes precedence over a configuration defined in the `dbt_project.yml` file. (Note that generic tests work a little differently when it comes to specificity. See dbt's documentation on [test configs](https://docs.getdbt.com/reference/test-configs).)

## What documents need to be updated

For good practice, the model owner should update the README file of the domain with a brief explanation. This will help users understand what the model is all about.
## Materialisations

Materialisations are strategies for persisting dbt models in a warehouse. There are four types of materializations built into dbt. They are:
Expand Down
1 change: 1 addition & 0 deletions source/documentation/tools/create-a-derived-table/quick-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ When you are ready to submit a pull request to merge models into the `main` bran
<li><b>Comprehensive Testing:</b> Ensure that the development models are accompanied by sufficient tests. There are many tests availble at column and table level, as well as the option to create user defined tests, more information <a href= "/tools/create-a-derived-table/tests">here</a>. Confirm these tests pass consistently. This is a critical validation step to provide model quality assurance to consumers.</li>
<li><b>Successful Deployment in Development: </b>Upon raising a pull request the <code>deploy-dev</code> workflow is triggered. This must complete successfully before any code can be merged into <code>main</code>. You may need to update your branch with the latest from <code>main</code> and resolve any conflicts.</li>
<li><b>Model Scheduling: </b>Determine the most appropriate scheduling for the model deployment that aligns to upstream deployment pipelines. For example, if the upstream sources are only updated weekly, a daily schedule may be unnecessary. Update the <a href="https://github.com/moj-analytical-services/create-a-derived-table/blob/main/mojap_derived_tables/dbt_project.yml">dbt_project.yml</a> using the corresponding schedule <code>tag</code>, more information <a href="/tools/create-a-derived-table/scheduling-to-prod">here</a>. Please note, <i>only</i> models with a declared schedule <code>tag</code> are deployed to production.</li>
<li><b>Documentation:</b> Ensure that the readme file of the associated domain is uploaded with a description of what the model is about, and provide the name of the team responsible for the model.
</ol>


Expand Down