-
Notifications
You must be signed in to change notification settings - Fork 90
Add a contrib folder
#46
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: | ||
| - 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
lennartkats-db marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.