Skip to content

Commit

Permalink
Moved examples to docs (#404)
Browse files Browse the repository at this point in the history
  • Loading branch information
nfx authored and FastLee committed Oct 25, 2023
1 parent ebcc752 commit af7fde5
Show file tree
Hide file tree
Showing 6 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ development cycle times and allowing for more immediate feedback during developm

```python
from databricks.sdk.service.workspace import AclPermission
from databricks.labs.ucx.providers.mixins.fixtures import * # noqa: F403
from databricks.labs.ucx.mixins.fixtures import * # noqa: F403

def test_secret_scope_acl(make_secret_scope, make_secret_scope_acl, make_group):
scope_name = make_secret_scope()
Expand All @@ -104,7 +104,7 @@ with the [Python plugin (Community Edition)](https://plugins.jetbrains.com/plugi
IntelliJ CE, then it would work in PyCharm. Debugging capabilities are essential for troubleshooting and diagnosing issues during
development. Please make sure that your test setup allows for easy debugging by following best practices.

![debugging tests](./examples/debugging-tests.gif)
![debugging tests](docs/debugging-tests.gif)

Adhering to these guidelines ensures that our integration tests are robust, efficient, and easily maintainable. This,
in turn, contributes to the overall reliability and quality of our software.
Expand Down Expand Up @@ -138,7 +138,7 @@ hatch run python -c "import sys; print(sys.executable)"
```

Configure your IDE to use this Python path so that you work within the virtual environment when developing the project:
![IDE Setup](./examples/hatch-intellij.gif)
![IDE Setup](docs/hatch-intellij.gif)

Before every commit, apply the consistent formatting of the code, as we want our codebase look consistent:
```shell
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Make sure you have Python 3.10 (or greater)
installed on your workstation, and you've configured authentication for
the [Databricks Workspace](https://databricks-sdk-py.readthedocs.io/en/latest/authentication.html#default-authentication-flow).

![install wizard](./examples/ucx-install.gif)
![install wizard](docs/ucx-install.gif)

The easiest way to install and authenticate is through a [Databricks configuration profile](https://docs.databricks.com/en/dev-tools/auth.html#databricks-client-unified-authentication):

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes

0 comments on commit af7fde5

Please sign in to comment.