Skip to content

Refine the sample readme.go.md #10681

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.

Sign up for GitHub

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
PhoenixHe-NV merged 1 commit into from
Sep 3, 2020
Merged

Refine the sample readme.go.md #10681

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions documentation/samplefiles/readme.go.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=<path to the root directory of your azure-sdk-for-go clone>`.

```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)
```

Expand All @@ -35,8 +37,10 @@ These settings apply only when `--tag=package-2020-07-01-preview --go` is specif
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

```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)
```