Skip to content

Commit

Permalink
Add Github button in documentation website (#40)
Browse files Browse the repository at this point in the history
Also add an Edit button on every doc page.
  • Loading branch information
matthieucan authored Jun 7, 2024
1 parent 341eefa commit e3d6e50
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to
## [Unreleased]

- Create contributors guide for the documentation website.
- Add Github icon and link to documentation website.

## [0.1.1] - 2023-06-03

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ organizations need, fully supported through the `meta` parameter.
At scale, with hundreds or thousands of data models, all this metadata can
become confusing, disparate, and inconsistent. It's hard to enforce good
practices and maintain them in continuous integration systems. This is where
`dbt-score` plays its role: by allowing data teams to programatically define and
enforce metadata rules, in an easy and scalable manner.
`dbt-score` plays its role: by allowing data teams to programmatically define
and enforce metadata rules, in an easy and scalable manner.

## Documentation

Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ theme:
favicon: assets/medal.svg
features:
- content.code.copy # Copy button for code blocks
- content.action.edit # Edit button pointing to Github
repo_url: https://github.com/PicnicSupermarket/dbt-score
plugins:
- search
- mkdocstrings
Expand Down

0 comments on commit e3d6e50

Please sign in to comment.