65edb54e88
Co-authored-by: blink-so[bot] <211532188+blink-so[bot]@users.noreply.github.com> Co-authored-by: matifali <104543375+matifali@users.noreply.github.com> Co-authored-by: DevCats <christofer@coder.com> Co-authored-by: Atif Ali <atif@coder.com>
59 lines
1.3 KiB
Markdown
59 lines
1.3 KiB
Markdown
---
|
|
name: TEMPLATE_NAME
|
|
description: A brief description of what this template does
|
|
tags: [tag1, tag2, tag3]
|
|
icon: /icon/TEMPLATE_NAME.svg
|
|
---
|
|
|
|
# TEMPLATE_NAME
|
|
|
|
A brief description of what this template provides and its use case.
|
|
|
|
## Features
|
|
|
|
- Feature 1
|
|
- Feature 2
|
|
- Feature 3
|
|
|
|
## Requirements
|
|
|
|
- List any prerequisites or requirements
|
|
- Provider-specific requirements (e.g., Docker, AWS credentials)
|
|
- Minimum Coder version if applicable
|
|
|
|
## Usage
|
|
|
|
1. Step-by-step instructions on how to use this template
|
|
2. Any configuration that needs to be done
|
|
3. How to customize the template
|
|
|
|
## Variables
|
|
|
|
| Name | Description | Type | Default | Required |
|
|
| ----------- | --------------------------- | -------- | ----------------- | -------- |
|
|
| example_var | Description of the variable | `string` | `"default_value"` | no |
|
|
|
|
## Resources Created
|
|
|
|
- List of resources that will be created
|
|
- Brief description of each resource
|
|
|
|
## Customization
|
|
|
|
Explain how users can customize this template for their needs:
|
|
|
|
- How to modify the startup script
|
|
- How to add additional software
|
|
- How to configure different providers
|
|
|
|
## Troubleshooting
|
|
|
|
### Common Issues
|
|
|
|
- Issue 1 and its solution
|
|
- Issue 2 and its solution
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please see the [contributing guidelines](../../CONTRIBUTING.md) for more information.
|