From 5888c2d28385806362f4cd80a4fc4ad2a3edd96d Mon Sep 17 00:00:00 2001 From: Lennart Kats Date: Thu, 21 Nov 2024 10:20:29 +0100 Subject: [PATCH 1/4] Add a contrib folder --- contrib/README.md | 43 +++++++++++++++++++++++++++++++++++++ contrib/templates/README.md | 10 +++++++++ 2 files changed, 53 insertions(+) create mode 100644 contrib/README.md create mode 100644 contrib/templates/README.md diff --git a/contrib/README.md b/contrib/README.md new file mode 100644 index 0000000..252d132 --- /dev/null +++ b/contrib/README.md @@ -0,0 +1,43 @@ +# Contrib Directory + +The `contrib` directory contains additional community-contributed examples and resources for Databricks Asset Bundles. These examples may include: + +- Custom configurations and extensions +- Advanced usage patterns +- Tools or utilities for enhancing Databricks Asset Bundles workflows + +## Structure + +Each contribution should be organized into its own subdirectory within `contrib/`. +Templates should go under `contrib/templates/`. For example: + +``` +contrib/ +├── awesome-bundle/ +│ ├── README.md +│ ├── databricks.yml +│ └── ... +└── templates/ + └── awesome-template/ + ├── README.md + ├── databricks_template_schema.json + ├── library/ + │ └── ... + └── template/ + └── ... +``` + +## How to Use Contributions + +To use or explore a contributed example, navigate to its subdirectory and follow the instructions in its `README.md` file. Each example should provide details on setup, configuration, and usage. + +## Contributing + +If you would like to add your own examples or resources, please: +1. Create a new directory under `contrib/` with a descriptive name. +2. Include a `README.md` file explaining the contribution. +3. Ensure that any necessary configuration files, scripts, or dependencies are included. + +For more information on Databricks Asset Bundles, see: +- [Public Preview Announcement](https://www.databricks.com/blog/announcing-public-preview-databricks-asset-bundles-apply-software-development-best-practices) +- [Databricks Asset Bundles Documentation](https://docs.databricks.com/dev-tools/bundles/index.html) \ No newline at end of file diff --git a/contrib/templates/README.md b/contrib/templates/README.md new file mode 100644 index 0000000..38d1654 --- /dev/null +++ b/contrib/templates/README.md @@ -0,0 +1,10 @@ +# Contrib/Templates directory + +This directory community-contributed templates. + +See https://github.com/databricks/bundle-examples/blob/main/contrib/README.md for +about community contributions. + +Looking to contribute? See https://github.com/databricks/cli/tree/main/libs/template/templates +for inspiration. These are the standard templates that are included with the +Databricks CLI. From 615bddc2fa0ada009daa8d5b9afdfbeb457df27d Mon Sep 17 00:00:00 2001 From: Lennart Kats Date: Thu, 21 Nov 2024 10:22:22 +0100 Subject: [PATCH 2/4] Update blog links --- README.md | 3 +-- contrib/README.md | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a5bf2e5..e48f440 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,5 @@ This repository provides Databricks Asset Bundles examples. To learn more, see: -* The public preview announcement at -https://www.databricks.com/blog/announcing-public-preview-databricks-asset-bundles-apply-software-development-best-practices +* The launch blog post at https://www.databricks.com/blog/announcing-general-availability-databricks-asset-bundles * The docs at https://docs.databricks.com/dev-tools/bundles/index.html diff --git a/contrib/README.md b/contrib/README.md index 252d132..31f7d01 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -39,5 +39,5 @@ If you would like to add your own examples or resources, please: 3. Ensure that any necessary configuration files, scripts, or dependencies are included. For more information on Databricks Asset Bundles, see: -- [Public Preview Announcement](https://www.databricks.com/blog/announcing-public-preview-databricks-asset-bundles-apply-software-development-best-practices) -- [Databricks Asset Bundles Documentation](https://docs.databricks.com/dev-tools/bundles/index.html) \ No newline at end of file +- The launch blog post at https://www.databricks.com/blog/announcing-general-availability-databricks-asset-bundles +- The docs at https://docs.databricks.com/dev-tools/bundles/index.html From 9905e284afd16ea903351309dda5998e9c779de8 Mon Sep 17 00:00:00 2001 From: "Lennart Kats (databricks)" Date: Thu, 21 Nov 2024 20:33:14 +0100 Subject: [PATCH 3/4] Update contrib/templates/README.md Co-authored-by: Pieter Noordhuis --- contrib/templates/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/templates/README.md b/contrib/templates/README.md index 38d1654..04aa5c1 100644 --- a/contrib/templates/README.md +++ b/contrib/templates/README.md @@ -1,6 +1,6 @@ # Contrib/Templates directory -This directory community-contributed templates. +This directory contains community-contributed templates. See https://github.com/databricks/bundle-examples/blob/main/contrib/README.md for about community contributions. From 6dcd476663e67b4570f42f9cf7cb104768b47b75 Mon Sep 17 00:00:00 2001 From: "Lennart Kats (databricks)" Date: Thu, 21 Nov 2024 20:34:01 +0100 Subject: [PATCH 4/4] Update contrib/templates/README.md --- contrib/templates/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/templates/README.md b/contrib/templates/README.md index 04aa5c1..e178680 100644 --- a/contrib/templates/README.md +++ b/contrib/templates/README.md @@ -2,7 +2,7 @@ This directory contains community-contributed templates. -See https://github.com/databricks/bundle-examples/blob/main/contrib/README.md for +See https://github.com/databricks/bundle-examples/blob/main/contrib/README.md to learn more about community contributions. Looking to contribute? See https://github.com/databricks/cli/tree/main/libs/template/templates