Skip to content

Commit e5e0512

Browse files
Add a contrib folder (#46)
Adds a `contrib` folder for community-contributed examples. --------- Co-authored-by: Pieter Noordhuis <[email protected]>
1 parent e140018 commit e5e0512

File tree

3 files changed

+54
-2
lines changed

3 files changed

+54
-2
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,5 @@
33
This repository provides Databricks Asset Bundles examples.
44

55
To learn more, see:
6-
* The public preview announcement at
7-
https://www.databricks.com/blog/announcing-public-preview-databricks-asset-bundles-apply-software-development-best-practices
6+
* The launch blog post at https://www.databricks.com/blog/announcing-general-availability-databricks-asset-bundles
87
* The docs at https://docs.databricks.com/dev-tools/bundles/index.html

contrib/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contrib Directory
2+
3+
The `contrib` directory contains additional community-contributed examples and resources for Databricks Asset Bundles. These examples may include:
4+
5+
- Custom configurations and extensions
6+
- Advanced usage patterns
7+
- Tools or utilities for enhancing Databricks Asset Bundles workflows
8+
9+
## Structure
10+
11+
Each contribution should be organized into its own subdirectory within `contrib/`.
12+
Templates should go under `contrib/templates/`. For example:
13+
14+
```
15+
contrib/
16+
├── awesome-bundle/
17+
│ ├── README.md
18+
│ ├── databricks.yml
19+
│ └── ...
20+
└── templates/
21+
└── awesome-template/
22+
├── README.md
23+
├── databricks_template_schema.json
24+
├── library/
25+
│ └── ...
26+
└── template/
27+
└── ...
28+
```
29+
30+
## How to Use Contributions
31+
32+
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.
33+
34+
## Contributing
35+
36+
If you would like to add your own examples or resources, please:
37+
1. Create a new directory under `contrib/` with a descriptive name.
38+
2. Include a `README.md` file explaining the contribution.
39+
3. Ensure that any necessary configuration files, scripts, or dependencies are included.
40+
41+
For more information on Databricks Asset Bundles, see:
42+
- The launch blog post at https://www.databricks.com/blog/announcing-general-availability-databricks-asset-bundles
43+
- The docs at https://docs.databricks.com/dev-tools/bundles/index.html

contrib/templates/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Contrib/Templates directory
2+
3+
This directory contains community-contributed templates.
4+
5+
See https://github.com/databricks/bundle-examples/blob/main/contrib/README.md to learn more
6+
about community contributions.
7+
8+
Looking to contribute? See https://github.com/databricks/cli/tree/main/libs/template/templates
9+
for inspiration. These are the standard templates that are included with the
10+
Databricks CLI.

0 commit comments

Comments
 (0)