Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 83112e6

Browse files
docs: update VERSION_METADATA.md per review feedback
- Update wording to be more specific about resources and data sources - Remove reference to deleted version_meta.go file - Clarify terraform-provider-coder v2.0 vs Coder v2.0 Co-authored-by: matifali <[email protected]>
1 parent e642c95 commit 83112e6

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

provider/VERSION_METADATA.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,9 @@ Results in documentation with:
8888

8989
## When to Add Version Information
9090

91-
- **Add @since: markers** for resources introduced after Coder v2.0
92-
- **Add @since: markers** for attributes added to existing resources
93-
- **Don't add markers** for resources that existed before Coder v2.0
91+
- **Add @since: markers** for newly introduced resources and data sources
92+
- **Add @since: markers** for attributes added to existing resources and data sources
93+
- **Don't add markers** for resources that existed before terraform-provider-coder v2.0
9494
- Resources and attributes without `@since:` markers won't show version information
9595

9696
## Best Practices
@@ -99,7 +99,4 @@ Results in documentation with:
9999
2. **Use semantic versioning** (vX.Y.Z format)
100100
3. **Test documentation generation** with `make gen` after adding markers
101101
4. **Keep descriptions concise** - the version marker is removed from the final docs
102-
5. **Use the version constants** from `version_meta.go` when available:
103-
```go
104-
Description: "My feature. @since:" + provider.V2_21_0,
105-
```
102+

0 commit comments

Comments
 (0)