diff --git a/documentation/samplefiles/readme.go.md b/documentation/samplefiles/readme.go.md index 932353580de4..ba38219f4d3e 100644 --- a/documentation/samplefiles/readme.go.md +++ b/documentation/samplefiles/readme.go.md @@ -23,9 +23,11 @@ These settings apply only when `--tag=package-2019-12-01 --go` is specified on t Please also specify `--go-sdk-folder=`. ```yaml $(tag) == 'package-2019-12-01' && $(go) +# NOTE: a stable tag must not contain any preview swagger files included # NOTE: go namespace can only consist of lower case letters, numbers and underscores namespace: yourservicename # NOTE: for special cases, you can hard code the namespace in the output-folder +# NOTE: the output-folder of a stable tag must not be under the preview subdirectory output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-12-01/$(namespace) ``` @@ -35,8 +37,10 @@ These settings apply only when `--tag=package-2020-07-01-preview --go` is specif Please also specify `--go-sdk-folder=`. ```yaml $(tag) == 'package-2020-07-01-preview' && $(go) +# NOTE: a preview tag must not contain at least one preview swagger file included # NOTE: go namespace can only consist of lower case letters, numbers and underscores namespace: yourservicename # NOTE: a preview api-version must be under the preview sub-directory +# NOTE: the output-folder of a preview tag must be under the preview subdirectory output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-07-01-preview/$(namespace) ```