Skip to content

Commit

Permalink
Updating docs.microsoft.com to learn.microsoft.com (#31831)
Browse files Browse the repository at this point in the history
* Update readme.md

Change docs.microsoft.com learn.microsoft.com

* Update readme.md

Change docs.microsoft.com to learn.microsoft.com

* Update ResolveDependencies.md

* Update ApiScenarioDefinition.md

* Update QuickStart.md

* Update swagger-authoring-descriptions.md
  • Loading branch information
lfraleigh authored Dec 12, 2024
1 parent 28a0baf commit 72de3f3
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion documentation/api-scenario/how-to/QuickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Run `oav run -h` to find all available options.

To run API test, first please prepare an AAD app which is used for provisioning Azure resource. Please grant subscription contributor permission to this AAD app.

For how to create AAD app, please follow this doc https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal
For how to create AAD app, please follow this doc https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal

## Authoring steps

Expand Down
2 changes: 1 addition & 1 deletion documentation/api-scenario/how-to/ResolveDependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,4 +319,4 @@ scenarios:

### ARM Template Deployment Script

ARM Template Deployment Script is supported in API Scenario, so that some complex operations with Azure PowerShell or CLI script can be performed in a single step. Refer to [ARM Template Deployment Script documentation](https://docs.microsoft.com/azure/azure-resource-manager/templates/deployment-script-template).
ARM Template Deployment Script is supported in API Scenario, so that some complex operations with Azure PowerShell or CLI script can be performed in a single step. Refer to [ARM Template Deployment Script documentation](https://learn.microsoft.com/azure/azure-resource-manager/templates/deployment-script-template).
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ Step to deploy ARM template to the scope. Template parameters and outputs will a

- **armTemplate**
- **Type:** Required, String
- Path to ARM template json file. See [ARM Template](https://docs.microsoft.com/azure/templates/).
- Path to ARM template json file. See [ARM Template](https://learn.microsoft.com/azure/templates/).

### Step ARM Deployment Script

Expand Down Expand Up @@ -282,10 +282,10 @@ Step to deploy ARM deployment script to the scope. Template parameters and outpu

- **armDeploymentScript**
- **Type:** Required, String
- Path to script file. See [ARM Deployment Script Template](https://docs.microsoft.com/azure/azure-resource-manager/templates/deployment-script-template).
- Path to script file. See [ARM Deployment Script Template](https://learn.microsoft.com/azure/azure-resource-manager/templates/deployment-script-template).
- **arguments**
- **Type:** Optional, String
- Arguments for the script. Same as arguments in ARM Template. See [ARM Deployment Script Template](https://docs.microsoft.com/azure/azure-resource-manager/templates/deployment-script-template).
- Arguments for the script. Same as arguments in ARM Template. See [ARM Deployment Script Template](https://learn.microsoft.com/azure/azure-resource-manager/templates/deployment-script-template).
- **environmentVariables**
- **Type:** Optional, Array of [EnvironmentVariable](#EnvironmentVariable)
- Specify the environment variables to pass over to the script.
Expand Down Expand Up @@ -623,4 +623,4 @@ on data:

result:
- throws error
```
```
6 changes: 3 additions & 3 deletions documentation/swagger-authoring-descriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
> C+E CSI SDK Documentation Team

> **The descriptions you write for the code elements in Swagger become the baseline public Azure REST API documentation on http://docs.microsoft.com.**
> **The descriptions you write for the code elements in Swagger become the baseline public Azure REST API documentation on http://learn.microsoft.com.**
These descriptions are also passed through by AutoRest to become triple-slash (///) comments in the corresponding client SDKs, which are likewise transformed into published baseline ref documentation.

This means that these docs are part of your product, and as ScottGu notes, a key part of your user experience. They're not just served up on docs.microsoft.com; they can also be discovered through Swagger UI (or other REST documentation client tools), command-line tools, and IntelliSense (for client SDKs). These descriptions represent your product and the hard work you put into making great APIs, and since we are Microsoft, our readers expect a polished experience.
This means that these docs are part of your product, and as ScottGu notes, a key part of your user experience. They're not just served up on learn.microsoft.com; they can also be discovered through Swagger UI (or other REST documentation client tools), command-line tools, and IntelliSense (for client SDKs). These descriptions represent your product and the hard work you put into making great APIs, and since we are Microsoft, our readers expect a polished experience.
Therefore, take the time to craft your descriptions well! This doc provides some basic advice from the C+E CSI content team, as well as various tips to ensure that your public Azure ref documentation looks clean, consistent, and great!

## Getting started
Expand All @@ -16,7 +16,7 @@ Therefore, take the time to craft your descriptions well! This doc provides some
2. Set yourself up with some good content support tools.
- [Grammarly](http://www.grammarly.com) is a web site that provides an English language grammar checker. Just cut-and-paste your description strings into it and review the suggested fixes.
- If you're using VSCode to edit your Swagger, consider one of these Swagger doc previewer extensions:
- [swagger-doc-viewer](https://marketplace.visualstudio.com/items?itemName=mimarec.swagger-doc-viewer) renders your Swagger file to a more readable format. Note that this format is not the same style as what will be generated for docs.microsoft.com.
- [swagger-doc-viewer](https://marketplace.visualstudio.com/items?itemName=mimarec.swagger-doc-viewer) renders your Swagger file to a more readable format. Note that this format is not the same style as what will be generated for learn.microsoft.com.
- [Arjun Swagger Viewer](https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer) is another Swagger preview extension, but has less validation warnings.
- [OpenAPI Linting Extension](https://github.com/Azure/openapi-lint-extension#preview) can be used to check your Swagger for common mistakes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Note that the Cognitive Services Language SDK is simply a wrapper on top of the


## Prerequisites
You must have a [Cognitive Services API account](https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account) with **Text Analytics API**.
You must have a [Cognitive Services API account](https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account) with **Text Analytics API**.

You must also have the [endpoint and access key](../How-tos/text-analytics-how-to-access-key.md) that was generated for you during sign up.

Expand All @@ -18,7 +18,7 @@ You must also have the [endpoint and access key](../How-tos/text-analytics-how-t
1. Select the NuGet package and install it.

## Calling the Text Analytics API using the SDK
See Text Analytics [Quickstart guide](https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/quickstarts/text-analytics-sdk?tabs=version-3&pivots=programming-language-csharp) for detailed instructions on how to use the SDK in your application.
See Text Analytics [Quickstart guide](https://learn.microsoft.com/azure/cognitive-services/text-analytics/quickstarts/text-analytics-sdk?tabs=version-3&pivots=programming-language-csharp) for detailed instructions on how to use the SDK in your application.

## Releases

Expand Down
2 changes: 1 addition & 1 deletion specification/cognitiveservices/resource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This is the AutoRest configuration file for CognitiveServices.

# Notice

Microsoft will use data you send to Bing Search Services or the Translator Speech API to improve Microsoft products and services. Where you send personal data to these Cognitive Services, you are responsible for obtaining sufficient consent from the data subjects. The General Privacy and Security Terms in the Online Services Terms do not apply to these Cognitive Services. Please refer to the Microsoft Cognitive Services section in the [Online Services Terms](https://www.microsoft.com/en-us/Licensing/product-licensing/products.aspx) for details. Microsoft offers policy controls that may be used to [disable new Cognitive Services deployments](https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-apis-create-account).
Microsoft will use data you send to Bing Search Services or the Translator Speech API to improve Microsoft products and services. Where you send personal data to these Cognitive Services, you are responsible for obtaining sufficient consent from the data subjects. The General Privacy and Security Terms in the Online Services Terms do not apply to these Cognitive Services. Please refer to the Microsoft Cognitive Services section in the [Online Services Terms](https://www.microsoft.com/en-us/Licensing/product-licensing/products.aspx) for details. Microsoft offers policy controls that may be used to [disable new Cognitive Services deployments](https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account).

---

Expand Down

0 comments on commit 72de3f3

Please sign in to comment.