From e906ecd90d7cfeb084f91ede091657b1223cf068 Mon Sep 17 00:00:00 2001 From: Sima Zhu <48036328+sima-zhu@users.noreply.github.com> Date: Thu, 17 Sep 2020 21:49:58 -0700 Subject: [PATCH] Replaced relative link with absolute links and remove locale (#12541) Replaced relative link with absolute links and remove locale --- README.md | 12 ++++++------ SECURITY.md | 6 +++--- eng/pipelines/templates/steps/analyze.yml | 1 + services/classic/management/README.md | 2 +- storage/README.md | 2 +- 5 files changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 69195aa1335d..31386b6a69b0 100644 --- a/README.md +++ b/README.md @@ -162,7 +162,7 @@ Authorization header and bearer token received from Azure AD. The SDK itself provides a simple way to get an authorizer which first checks for OAuth client credentials in environment variables and then falls back to -Azure's [Managed Service Identity]() when available, e.g. when on an Azure +Azure's [Managed Service Identity](https://github.com/Azure/azure-sdk-for-go/) when available, e.g. when on an Azure VM. The following snippet from [the previous section](#use) demonstrates this helper. @@ -206,7 +206,7 @@ below. > for more info. Copy the new principal's ID, secret, and tenant ID for use in > your app, or consider the `--sdk-auth` parameter for serialized output. -[azure managed service identity]: https://docs.microsoft.com/en-us/azure/active-directory/msi-overview +[azure managed service identity]: https://docs.microsoft.com/azure/active-directory/msi-overview - The `auth.NewAuthorizerFromEnvironment()` described above creates an authorizer from the first available of the following configuration: @@ -235,7 +235,7 @@ below. 4. **Azure Managed Service Identity**: Delegate credential management to the platform. Requires that code is running in Azure, e.g. on a VM. All configuration is handled by Azure. See [Azure Managed Service - Identity](https://docs.microsoft.com/en-us/azure/active-directory/msi-overview) + Identity](https://docs.microsoft.com/azure/active-directory/msi-overview) for more details. - The `auth.NewAuthorizerFromFile()` method creates an authorizer using @@ -268,7 +268,7 @@ below. To use `NewAuthorizerFromCLI()` or `NewAuthorizerFromCLIWithResource()`, follow these steps: - 1. Install [Azure CLI v2.0.12](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) or later. Upgrade earlier versions. + 1. Install [Azure CLI v2.0.12](https://docs.microsoft.com/cli/azure/install-azure-cli) or later. Upgrade earlier versions. 2. Use `az login` to sign in to Azure. If you receive an error, use `az account get-access-token` to verify access. @@ -485,7 +485,7 @@ To hook up a tracer simply call `tracing.Register()` passing in a type that sati ### Usage -Once enabled, all SDK calls will emit traces and metrics and the traces will correlate the SDK calls with the raw http calls made to Azure API's. To consume those traces, if are not doing it yet, you need to register an exporter of your choice such as [Azure App Insights](https://docs.microsoft.com/en-us/azure/application-insights/opencensus-local-forwarder) or [Zipkin](https://opencensus.io/quickstart/go/tracing/#exporting-traces). +Once enabled, all SDK calls will emit traces and metrics and the traces will correlate the SDK calls with the raw http calls made to Azure API's. To consume those traces, if are not doing it yet, you need to register an exporter of your choice such as [Azure App Insights](https://docs.microsoft.com/azure/application-insights/opencensus-local-forwarder) or [Zipkin](https://opencensus.io/quickstart/go/tracing/#exporting-traces). To correlate the SDK calls between them and with the rest of your code, pass in a context that has a span initiated using the [opencensus-go library](https://github.com/census-instrumentation/opencensus-go) using the `trace.Startspan(ctx context.Context, name string, o ...StartOption)` function. Here is an example: @@ -587,6 +587,6 @@ Security issues and bugs should be reported privately, via email, to the Microso ## Contribute -See [CONTRIBUTING.md](./CONTRIBUTING.md). +See [CONTRIBUTING.md](https://github.com/Azure/azure-sdk-for-go/blob/master/CONTRIBUTING.md). [samples_repo]: https://github.com/Azure-Samples/azure-sdk-for-go-samples diff --git a/SECURITY.md b/SECURITY.md index 926b8ae4059a..dec3d3b7013b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,7 +4,7 @@ Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). -If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. +If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. ## Reporting Security Issues @@ -12,7 +12,7 @@ If you believe you have found a security vulnerability in any Microsoft-owned re Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). -If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). +If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/msrc/pgp-key-msrc). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). @@ -36,6 +36,6 @@ We prefer all communications to be in English. ## Policy -Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). +Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/msrc/cvd). diff --git a/eng/pipelines/templates/steps/analyze.yml b/eng/pipelines/templates/steps/analyze.yml index d14c16f89c9c..a346570104a7 100644 --- a/eng/pipelines/templates/steps/analyze.yml +++ b/eng/pipelines/templates/steps/analyze.yml @@ -10,6 +10,7 @@ steps: - template: /eng/common/pipelines/templates/steps/verify-links.yml parameters: Directory: sdk/${{ parameters.ServiceDirectory }} + CheckLinkGuidance: $true - script: | curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${{parameters.LintVersion}} diff --git a/services/classic/management/README.md b/services/classic/management/README.md index 2dae152e69dc..51990257c881 100644 --- a/services/classic/management/README.md +++ b/services/classic/management/README.md @@ -2,7 +2,7 @@ The `github.com/Azure/azure-sdk-for-go/services/classic/management` packages are used to perform operations using the Azure Service Management (ASM), aka classic deployment model. Read more about [Azure Resource Manager vs. classic deployment](https://azure.microsoft.com/documentation/articles/resource-manager-deployment-model/). Packages for Azure Resource Manager are in the [services](https://github.com/Azure/azure-sdk-for-go/tree/master/services) folder. Note that this package requires Go 1.7+ to build. -This package is in mainteinance mode and will only receive bug fixes. It is recommended to [migrate to Azure Resource Manager](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-deployment-model) deployment model. +This package is in mainteinance mode and will only receive bug fixes. It is recommended to [migrate to Azure Resource Manager](https://docs.microsoft.com/azure/azure-resource-manager/resource-manager-deployment-model) deployment model. ## First a Sidenote: Authentication and the Azure Service Manager diff --git a/storage/README.md b/storage/README.md index 459b45831c0e..16f5dad1992a 100644 --- a/storage/README.md +++ b/storage/README.md @@ -10,7 +10,7 @@ future. Please use one of the following packages instead. | Storage - Queues | [github.com/Azure/azure-storage-queue-go](https://github.com/Azure/azure-storage-queue-go) | The `github.com/Azure/azure-sdk-for-go/storage` package is used to manage -[Azure Storage](https://docs.microsoft.com/en-us/azure/storage/) data plane +[Azure Storage](https://docs.microsoft.com/azure/storage/) data plane resources: containers, blobs, tables, and queues. To manage storage *accounts* use Azure Resource Manager (ARM) via the packages