Update README.md with Template Documentation #529
Conversation
This file contains 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
hosekpeter
reviewed
Feb 7, 2025
| @@ -0,0 +1,42 @@ | |||
| Update `@README.md` with the latest information about available templates. | |||
There was a problem hiding this comment.
typo: rename pompt.txt -> prompt.txt
There was a problem hiding this comment.
maybe this file should be in the .gitignore 🤔
There was a problem hiding this comment.
I think it can be in git.
hosekpeter
approved these changes
Feb 7, 2025
Matovidlo
approved these changes
Feb 7, 2025
| @@ -0,0 +1,42 @@ | |||
| Update `@README.md` with the latest information about available templates. | |||
There was a problem hiding this comment.
I think it can be in git.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR updates the README.md file by adding a 'How to Create a Template' section and an 'Available Templates' section.\n\nThe 'How to Create a Template' section explains how to create a new template by reviewing the documentation in the /developers-docs/cli/templates folder (including the tutorial, structure, and tests subfolders), creating a new folder under /templates with a unique identifier (which serves as the template's ID), adding a configuration file with the template’s name, description, and version details, and specifying the supported backend(s) (e.g., snowflake) along with required components.\n\nThe 'Available Templates' section documents all non-deprecated templates extracted from repository.json. Each entry lists the template’s Name, Description, Backend Support, Included Components, Template Version, and Folder Location.\n\nNote: <keboola.wr-snowflake> is a placeholder for a Snowflake writer on a specific stack and should be replaced with the appropriate configuration if needed.\n\nPlease review and merge these changes.