From af7fde57470021a7094b79effe99f2014b9b84e6 Mon Sep 17 00:00:00 2001 From: Serge Smertin <259697+nfx@users.noreply.github.com> Date: Sat, 7 Oct 2023 12:43:08 +0200 Subject: [PATCH] Moved examples to docs (#404) --- CONTRIBUTING.md | 6 +++--- README.md | 2 +- {examples => docs}/debugging-tests.gif | Bin {examples => docs}/hatch-intellij.gif | Bin {examples => docs}/migration_config.yml | 0 {examples => docs}/ucx-install.gif | Bin 6 files changed, 4 insertions(+), 4 deletions(-) rename {examples => docs}/debugging-tests.gif (100%) rename {examples => docs}/hatch-intellij.gif (100%) rename {examples => docs}/migration_config.yml (100%) rename {examples => docs}/ucx-install.gif (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 628624f121..00c6628ab8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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() @@ -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. @@ -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 diff --git a/README.md b/README.md index 88ef0ff7d6..996b97898a 100644 --- a/README.md +++ b/README.md @@ -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): diff --git a/examples/debugging-tests.gif b/docs/debugging-tests.gif similarity index 100% rename from examples/debugging-tests.gif rename to docs/debugging-tests.gif diff --git a/examples/hatch-intellij.gif b/docs/hatch-intellij.gif similarity index 100% rename from examples/hatch-intellij.gif rename to docs/hatch-intellij.gif diff --git a/examples/migration_config.yml b/docs/migration_config.yml similarity index 100% rename from examples/migration_config.yml rename to docs/migration_config.yml diff --git a/examples/ucx-install.gif b/docs/ucx-install.gif similarity index 100% rename from examples/ucx-install.gif rename to docs/ucx-install.gif