Skip to content
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.

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

Missing supported data feed sources on DataFeedSource docs #24640

Closed
Gyeonghun-Park opened this issue Oct 11, 2021 · 6 comments
Closed

Missing supported data feed sources on DataFeedSource docs #24640

Gyeonghun-Park opened this issue Oct 11, 2021 · 6 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Cognitive - Metrics Advisor customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs question The issue doesn't require a change to the product in order to be resolved. Most issues start as that
Milestone

Comments

@Gyeonghun-Park
Copy link
Contributor

There should be AzureApplicationInsightsDataFeedSource, AzureBlobDataFeedSource, AzureCosmosDbDataFeedSource, AzureDataExplorerDataFeedSource, AzureDataLakeStorageDataFeedSource, AzureEventHubsDataFeedSource, AzureTableDataFeedSource, InfluxDbDataFeedSource, LogAnalyticsDataFeedSource, MongoDbDataFeedSource, MySqlDataFeedSource, PostgreSqlDataFeedSource and SqlServerDataFeedSource, not empty bulleted list.

Screenshot 2021-10-11 221406

Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@ghost ghost added needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Oct 11, 2021
@jsquire jsquire added Client This issue points to a problem in the data-plane of the library. Cognitive - Metrics Advisor Docs needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team labels Oct 11, 2021
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Oct 11, 2021
@jsquire
Copy link
Member

jsquire commented Oct 11, 2021

Thank you for your feedback. Tagging and routing to the team member best able to assist.

@jsquire
Copy link
Member

jsquire commented Oct 11, 2021

@kinelski: The root cause for this is that the <list> tags are malformed in the class summary area, here. The <list> must have a child element of <description> and, optionally, may have a child <term> as well. (ref)

We'll need to wrap the <see> elements for them to render correctly. (example)

@Gyeonghun-Park
Copy link
Contributor Author

Hello @jsquire,
Can I add <description> tag to DataFeedSource.cs file and make a PR for this issue?

/// <list type="bullet">
/// <item><see cref="AzureApplicationInsightsDataFeedSource"/></item>
/// <item><see cref="AzureBlobDataFeedSource"/></item>
/// <item><see cref="AzureCosmosDbDataFeedSource"/></item>
/// <item><see cref="AzureDataExplorerDataFeedSource"/></item>
/// <item><see cref="AzureDataLakeStorageDataFeedSource"/></item>
/// <item><see cref="AzureEventHubsDataFeedSource"/></item>
/// <item><see cref="AzureTableDataFeedSource"/></item>
/// <item><see cref="InfluxDbDataFeedSource"/></item>
/// <item><see cref="LogAnalyticsDataFeedSource"/></item>
/// <item><see cref="MongoDbDataFeedSource"/></item>
/// <item><see cref="MySqlDataFeedSource"/></item>
/// <item><see cref="PostgreSqlDataFeedSource"/></item>
/// <item><see cref="SqlServerDataFeedSource"/></item>
/// </list>

@jsquire
Copy link
Member

jsquire commented Oct 11, 2021

Hi @Gyeonghun-Park. Thank you for offering to help improve the Azure SDK experience! Generally, we love contributions and this doesn't appear to be generated code - but I'd like to ask @kinelski for his thoughts. I don't want to see you spend time if this is something that needs an upstream change in the swagger.

@kinelski
Copy link
Member

Hello @Gyeonghun-Park. Feel free to create a PR with the fix! I'm assigning this issue to you. Let me know if you have any questions.

@kinelski kinelski assigned Gyeonghun-Park and unassigned kinelski Oct 15, 2021
@kinelski kinelski added this to the Backlog milestone Oct 15, 2021
@kinelski kinelski removed the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Oct 15, 2021
@kinelski
Copy link
Member

Fixed by @Gyeonghun-Park in #24764.

@github-actions github-actions bot locked and limited conversation to collaborators Mar 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Cognitive - Metrics Advisor customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs question The issue doesn't require a change to the product in order to be resolved. Most issues start as that
Projects
None yet
Development

No branches or pull requests

3 participants