update api ref links #17189
update api ref links #17189
Conversation
swathipil
requested review from
annatisch,
danieljurek,
mitchdenny,
rakshith91,
scbedd,
weshaggard and
yunhaoling
as code owners
ghost
added
the
|
Hello @yunhaoling! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
ghost
merged commit 
| @@ -3,3 +3,7 @@ https://github.com/Azure/azure-digital-twins/blob/private-preview/Documentation/ | |||
| https://pypi.org/project/azure-digitaltwins-core | |||
| https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations | |||
| https://docs.microsoft.com/samples/azure-samples/azure-samples-python-management/{{package_doc_id}} | |||
| https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/5.3.1/azure.eventhub.html | |||
There was a problem hiding this comment.
In general it is a bad idea to add links to the ignore list as that implies that we have broken links, even if they are supposed to only be temporarily broken. Instead we should try to have links in our README files that aren't in this broken state.
There was a problem hiding this comment.
that makes sense, thanks for the feedback! for context, we were releasing 2 versions of EH. The first, version 5.4.0b1, was on a feature branch and the second, version 5.3.1, was on the master branch. We were trying to work around having our API ref documentation links on master point to .../latest/azure.eventhub.html since that would reference version 5.4.0b1 rather than 5.3.1. In order to make the PR pass, we wanted to ignore it and remove these ignored links once they became valid. Since this would be a temporary fix (which we should try to avoid), would you know of a way to tackle this kind of situation in the future?
There was a problem hiding this comment.
Please refer to some of the guidelines around links at https://github.com/Azure/azure-sdk/blob/master/docs/policies/README-TEMPLATE.md#link-guidelines
There was a problem hiding this comment.
will do in the future, thanks!
[Hub Generated] Review request for Microsoft.DataFactory to add version stable/2018-06-01 (Azure#17189) * Add FailActivity in swagger Pipeline.json for Azure Data Factory * Update description of FailActivity * Adding 'type:object' to FailActivity and FailActivityTypeProperties
* CodeGen from PR 17189 in Azure/azure-rest-api-specs [Hub Generated] Review request for Microsoft.DataFactory to add version stable/2018-06-01 (#17189) * Add FailActivity in swagger Pipeline.json for Azure Data Factory * Update description of FailActivity * Adding 'type:object' to FailActivity and FailActivityTypeProperties * version,CHANGELOG Co-authored-by: SDKAuto <sdkautomation@microsoft.com> Co-authored-by: PythonSdkPipelines <PythonSdkPipelines> Co-authored-by: Jiefeng Chen <51037443+BigCat20196@users.noreply.github.com>
* CodeGen from PR 17189 in Azure/azure-rest-api-specs [Hub Generated] Review request for Microsoft.DataFactory to add version stable/2018-06-01 (Azure#17189) * Add FailActivity in swagger Pipeline.json for Azure Data Factory * Update description of FailActivity * Adding 'type:object' to FailActivity and FailActivityTypeProperties * version,CHANGELOG Co-authored-by: SDKAuto <sdkautomation@microsoft.com> Co-authored-by: PythonSdkPipelines <PythonSdkPipelines> Co-authored-by: Jiefeng Chen <51037443+BigCat20196@users.noreply.github.com>
No description provided.