Skip to content

Commit

Permalink
Fixed docs-build (#129)
Browse files Browse the repository at this point in the history
## Changes
* Updated link in the guides
* Added docs build on push
* Removed duplicated contributing guide

### Tests
<!-- How is this tested? Please see the checklist below and also
describe any other relevant tests -->

- [x] manually tested
- [ ] added unit tests
- [ ] added integration tests
  • Loading branch information
mwojtyczka authored Jan 23, 2025
1 parent 236ca71 commit 0d9ca3c
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 179 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,24 @@ jobs:

- name: Fail on differences
run: git diff --exit-code

docs:
name: Build Docusaurus
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs/dqx
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20
cache: yarn
cache-dependency-path: docs/dqx/yarn.lock # need to put the lockfile path explicitly

- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build
177 changes: 0 additions & 177 deletions CONTRIBUTING.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/dqx/docs/guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ dlt_expectations = dlt_generator.generate_dlt_rules(profiles)

### Using CLI

You must install DQX in the workspace before (see [installation](/docs/installation#installation-in-a-databricks-workspace)).
As part of the installation, profiler workflow is installed. It can be run manually in the workspace UI or using the CLI as below.
You must install DQX in the workspace before, see the [Installation Guide](/docs/installation#dqx-installation-in-a-databricks-workspace).
As part of the installation, profiler workflow is installed. The workflow can be run manually in the workspace UI or using the CLI as below.

Run profiler workflow:
```commandline
Expand Down

0 comments on commit 0d9ca3c

Please sign in to comment.