From 4372359c7262fa5d451b25a5b6dc95a1db0ae73e Mon Sep 17 00:00:00 2001 From: David Coulter Date: Wed, 30 Sep 2020 14:11:36 -0700 Subject: [PATCH] Links: Azure DevOps - extend (#2221) --- docs/extend/develop/configure-workitemform-extensions.md | 4 ++-- docs/extend/develop/pipeline-decorator-context.md | 4 ++-- docs/extend/develop/static-content.md | 5 ++--- docs/extend/develop/work-with-urls.md | 4 ++-- docs/extend/extension-report.md | 5 ++--- docs/extend/includes/manifest-core.md | 4 ++-- docs/extend/includes/manifest-extension-runtime.md | 9 +++------ docs/extend/includes/procedures/create-action-js.md | 4 ++-- docs/extend/includes/tip-for-more-information.md | 4 +--- docs/extend/overview.md | 5 ++--- 10 files changed, 20 insertions(+), 28 deletions(-) diff --git a/docs/extend/develop/configure-workitemform-extensions.md b/docs/extend/develop/configure-workitemform-extensions.md index 21971673dc8..01246bd3c76 100644 --- a/docs/extend/develop/configure-workitemform-extensions.md +++ b/docs/extend/develop/configure-workitemform-extensions.md @@ -16,7 +16,7 @@ ms.date: 10/10/2017 [!INCLUDE [version-tfs-2017-through-vsts](../../includes/version-tfs-2017-through-vsts.md)] -A work item type can be exported as XML using `witadmin` tool, that includes the layout of the work item form. As part of the walkthrough, you add the page, group, and control contributions to the layout. [Read more information on WebLayout XML](/azure/devops/reference/xml/weblayout-xml-elements). In this example, we add the control to the Agile "User Story" work item type. +A work item type can be exported as XML using `witadmin` tool, that includes the layout of the work item form. As part of the walkthrough, you add the page, group, and control contributions to the layout. [Read more information on WebLayout XML](../../reference/xml/weblayout-xml-elements.md). In this example, we add the control to the Agile "User Story" work item type. [!INCLUDE [extension-docs-new-sdk](../../includes/extension-docs-new-sdk.md)] @@ -130,4 +130,4 @@ Note that if a control contribution has any required input defined, users must g
Step 7: Finally, import this .xml file, using witadmin. -witadmin importwitd /collection:CollectionURL /p:Project /f:FileName \ No newline at end of file +witadmin importwitd /collection:CollectionURL /p:Project /f:FileName \ No newline at end of file diff --git a/docs/extend/develop/pipeline-decorator-context.md b/docs/extend/develop/pipeline-decorator-context.md index 396495dd5e3..76e3be9218e 100644 --- a/docs/extend/develop/pipeline-decorator-context.md +++ b/docs/extend/develop/pipeline-decorator-context.md @@ -33,7 +33,7 @@ Currently, there's only one key: `repositories`. In a designer build, the primary repo alias is `__designer_repo`. In a YAML pipeline, the primary repo is called `self`. In a release pipeline, repositories aren't available. -[Release artifact variables](https://docs.microsoft.com/azure/devops/pipelines/release/variables?tabs=batch) are available. +[Release artifact variables](../../pipelines/release/variables.md?tabs=batch) are available. For example, to print the name of the `self` repo in a YAML pipeline: ``` @@ -182,4 +182,4 @@ steps: > [!TIP] > Each of these GUIDs can be found in the `task.json` for the corresponding [in-box task](https://github.com/microsoft/azure-pipelines-tasks). > The only exception is `checkout`, which is a native capability of the agent. -> Its GUID is built into the Azure Pipelines service and agent. +> Its GUID is built into the Azure Pipelines service and agent. \ No newline at end of file diff --git a/docs/extend/develop/static-content.md b/docs/extend/develop/static-content.md index aa5dc179905..35b291250bd 100644 --- a/docs/extend/develop/static-content.md +++ b/docs/extend/develop/static-content.md @@ -45,7 +45,7 @@ Your extension's static content is useful when you're enhancing or decorating da ``` 2. Remove the `baseUri` property (if set) from your extension manifest. 3. Package your extension ([steps](../publish/command-line.md)) -4. Publish (or republish) your extension ([steps](/azure/devops/extend/publish/overview)) +4. Publish (or republish) your extension ([steps](../publish/overview.md))
> [!IMPORTANT] @@ -88,5 +88,4 @@ In this model, static content is served from your own service and not included i ## Next steps > [!div class="nextstepaction"] -> [Package, publish, and install extensions](/azure/devops/extend/publish/overview) - +> [Package, publish, and install extensions](../publish/overview.md) \ No newline at end of file diff --git a/docs/extend/develop/work-with-urls.md b/docs/extend/develop/work-with-urls.md index 7ef263cf4f2..efa1c4be37d 100644 --- a/docs/extend/develop/work-with-urls.md +++ b/docs/extend/develop/work-with-urls.md @@ -21,7 +21,7 @@ With the introduction of Azure DevOps Services, organizational resources and API Regardless of when the organization was created, users, tools, and integrations can interact with organization-level REST APIs using either URL. As the developer of an extension, integration, or tool that interacts with Azure DevOps Services, it is important to understand how to properly work with URLs made available to your code and how to properly form URLs when calling REST APIs. -For more information, see the [REST API Reference](https://docs.microsoft.com/rest/api/azure/devops/?view=azure-devops-rest-5.1). +For more information, see the [REST API Reference](/rest/api/azure/devops/?view=azure-devops-rest-5.1). ## Organization primary URL @@ -304,4 +304,4 @@ This table shows the IDs for common resource areas. See the previous section for ## Next steps > [!div class="nextstepaction"] -> [Make your extension or integration public](https://azdevinternal.azureedge.net/) +> [Make your extension or integration public](https://azdevinternal.azureedge.net/) \ No newline at end of file diff --git a/docs/extend/extension-report.md b/docs/extend/extension-report.md index 3cb128fca29..95ac1245fb7 100644 --- a/docs/extend/extension-report.md +++ b/docs/extend/extension-report.md @@ -14,7 +14,7 @@ ms.date: 11/12/2019 [!INCLUDE [version-tfs-2017-through-vsts](../includes/version-tfs-2017-through-vsts.md)] -Once your extension is available in the [Visual Studio Marketplace](/azure/devops/extend/extension-report) you can use the **Reports** feature. With this feature, you can track and analyze how the extension is performing and take required actions. +Once your extension is available in the [Visual Studio Marketplace]() you can use the **Reports** feature. With this feature, you can track and analyze how the extension is performing and take required actions. To visit the extension hub, browse to your [publisher page](https://aka.ms/vsmarketplace-manage) and select the extension or select the **Reports** link on the extension details page. ## Acquisition @@ -85,5 +85,4 @@ For more information and guidance on communication with customers, see the [Mar * **Page views**: total number of extension detail page views. Repeated views are counted. * **Azure DevOps installs**: total number of organizations the extension is installed in. Repeated installs on the same organization are counted. -* **TFS installs**: total number of TFS connected accounts the extension is installed in. Repeated installs on the same organization are counted. TFS disconnected server data isn't available. - +* **TFS installs**: total number of TFS connected accounts the extension is installed in. Repeated installs on the same organization are counted. TFS disconnected server data isn't available. \ No newline at end of file diff --git a/docs/extend/includes/manifest-core.md b/docs/extend/includes/manifest-core.md index f761a7fda04..62d6bc7e212 100644 --- a/docs/extend/includes/manifest-core.md +++ b/docs/extend/includes/manifest-core.md @@ -7,6 +7,6 @@ These properties are required: | **ID** | *The extension's identifier.* | Th ID is a string that must be unique among extensions from the same publisher. It must start with an alphabetic or numeric character and contain 'A' through 'Z', 'a' through 'z', '0' through '9', and '-' (hyphen). Example: `sample-extension`. | | **version** | *A string specifying the version of an extension.* | Should be in the format `major.minor.patch`, for example `0.1.2` or `1.0.0`. You can also add a fourth number for the following format: `0.1.2.3`| | **name** | *A short, human-readable name of the extension. Limited to 200 characters.* | Example: `"Fabrikam Agile Board Extension"`. | -| **publisher** | *The identifier of the publisher.* | This identifier must match the identifier the extension is published under. See [Create and manage a publisher](/azure/devops/extend/publish/overview). | +| **publisher** | *The identifier of the publisher.* | This identifier must match the identifier the extension is published under. See [Create and manage a publisher](../publish/overview.md). | | **categories** | *Array of strings representing the categories your extension belongs to. At least one category must be provided and there's no limit to how many categories you may include.* | Valid values: `Azure Repos`, `Azure Boards`, `Azure Pipelines`, `Azure Test Plans`, and `Azure Artifacts`.

Notes:| -| **targets** | *The products and services supported by your integration or extension.* For more information, see [installation targets](/azure/devops/extend/develop/manifest#installation-targets). | An array of objects, where each object has an `id` field indicating one of the following: | \ No newline at end of file +| **targets** | *The products and services supported by your integration or extension.* For more information, see [installation targets](../develop/manifest.md#installation-targets). | An array of objects, where each object has an `id` field indicating one of the following: | \ No newline at end of file diff --git a/docs/extend/includes/manifest-extension-runtime.md b/docs/extend/includes/manifest-extension-runtime.md index b148f2dcba9..7b3b821ec93 100644 --- a/docs/extend/includes/manifest-extension-runtime.md +++ b/docs/extend/includes/manifest-extension-runtime.md @@ -1,10 +1,7 @@ - | Property | Description | Notes | | --- | --- | --- | -| **scopes** | *An array of authorization scopes (strings) listing permissions required by your extension.* | For example, `vso.work` and `vs.code_write` indicates your extension needs read-only access to work items and read/write access to source code (and related resource). Scopes are presented to the user when installing your extension. For more information, see the [full list of scopes](/azure/devops/extend/develop/manifest#scopes). | -| **demands** | *An array of demands (strings) listing the capabilities required by your extension.* | For example, `api-version/3.0` indicates that your extension uses version 3.0 APIs, and so can't run in older products that don't support this version. For more information, see the [full list of demands](/azure/devops/extend/develop/manifest#demands). | +| **scopes** | *An array of authorization scopes (strings) listing permissions required by your extension.* | For example, `vso.work` and `vs.code_write` indicates your extension needs read-only access to work items and read/write access to source code (and related resource). Scopes are presented to the user when installing your extension. For more information, see the [full list of scopes](../develop/manifest.md#scopes). | +| **demands** | *An array of demands (strings) listing the capabilities required by your extension.* | For example, `api-version/3.0` indicates that your extension uses version 3.0 APIs, and so can't run in older products that don't support this version. For more information, see the [full list of demands](../develop/manifest.md#demands). | | **baseUri** | *(Optional) base URL for all relative URLs specified by the extension's contributions.* | For example: ```https://myapp.com/{{account.name}}/```. This property should be left empty if your extension's contents are packaged with your extension. | | **contributions** | *An array of contributions to the system.* | | -| **contributionTypes** | *An array of contribution types defined by the extension* | | - - +| **contributionTypes** | *An array of contribution types defined by the extension* | | \ No newline at end of file diff --git a/docs/extend/includes/procedures/create-action-js.md b/docs/extend/includes/procedures/create-action-js.md index 334a4273a2e..fb25c1aeff2 100644 --- a/docs/extend/includes/procedures/create-action-js.md +++ b/docs/extend/includes/procedures/create-action-js.md @@ -25,7 +25,7 @@ | text | Text that appears on the menu item. | | title | Tooltip text that appears on the menu item. | | icon | URL to an icon that appears on the menu item. Relative URLs are resolved using baseUri. | - | groupId | Determines where this menu item appears in relation to the others. [How to discover menu group identifiers](../../test/discover-menu-group-ids.md) | + | groupId | Determines where this menu item appears in relation to the others. [How to discover menu group identifiers](../../overview.md) | | uri | URI to a page that registers the menu action handler (see below). | | registeredObjectId | (Optional) Name of the registered menu action handler. Defaults to the contribution id. | @@ -76,4 +76,4 @@ 4. Install your extension and try it out. The action has been added to the context menu for queries and folders in the queries hub (work hub group). - ![action in the context menu of a query](../../media-procedures/create-action/action.png) + ![action in the context menu of a query](../../media-procedures/create-action/action.png) \ No newline at end of file diff --git a/docs/extend/includes/tip-for-more-information.md b/docs/extend/includes/tip-for-more-information.md index 9991f6f1af0..68310adffd6 100644 --- a/docs/extend/includes/tip-for-more-information.md +++ b/docs/extend/includes/tip-for-more-information.md @@ -1,4 +1,2 @@ - > [!TIP] -> For more information, see [Extensibility points, menus and toolbars](../reference/targets/overview.md#menus-and-toolbars), the [Contribution model](../develop/contributions-overview.md) the [Formula Design System](https://developer.microsoft.com/en-us/azure-devops/develop/extensions), [REST API reference](https://docs.microsoft.com/rest/api/azure/devops/?view=azure-devops-rest-6.1&viewFallbackFrom=azure-devops-rest-5.1), [Extension samples](https://github.com/Microsoft/azure-devops-extension-sample), and resources in the [Developer Community](https://developercommunity.visualstudio.com/spaces/21/index.html). - +> For more information, see [Extensibility points, menus and toolbars](/previous-versions/azure/devops/docs/extend/reference/targets/overview#menus-and-toolbars), the [Contribution model](../develop/contributions-overview.md) the [Formula Design System](https://developer.microsoft.com/en-us/azure-devops/develop/extensions), [REST API reference](/rest/api/azure/devops/?view=azure-devops-rest-6.1&viewFallbackFrom=azure-devops-rest-5.1), [Extension samples](https://github.com/Microsoft/azure-devops-extension-sample), and resources in the [Developer Community](https://developercommunity.visualstudio.com/spaces/21/index.html). \ No newline at end of file diff --git a/docs/extend/overview.md b/docs/extend/overview.md index 92859fad23a..699cfd9a39b 100644 --- a/docs/extend/overview.md +++ b/docs/extend/overview.md @@ -62,7 +62,7 @@ You can develop an extension for your continuous delivery pipeline as described - [Build your first extension](./get-started/node.md) - [Samples](./develop/samples-overview.md) 3. Familiarize yourself with our RESTful APIs. If you're integrating from a third party app or service, you'll also want to check out our Service Hooks - - [REST APIs](https://docs.microsoft.com/rest/api/azure/devops/?view=azure-devops-rest-5.1) + - [REST APIs](/rest/api/azure/devops/?view=azure-devops-rest-5.1) - [Service Hooks](../service-hooks/overview.md) 4. Once your extension is ready, you'll want to package it, publish it to the Marketplace, and then we hope you'll share it with the community! - [Package, publish, and install your extension](./publish/overview.md) @@ -79,5 +79,4 @@ You can develop an extension for your continuous delivery pipeline as described * [Visual Studio Marketplace](https://marketplace.visualstudio.com/azuredevops) * [Extension Publisher Page](https://marketplace.visualstudio.com/manage) * [Visual Studio Partner Program](https://vspartner.com/) -* [Extension manifest reference](./develop/manifest.md) - +* [Extension manifest reference](./develop/manifest.md) \ No newline at end of file