-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Correct Sample README Product slug #20679
Conversation
@@ -4,7 +4,7 @@ languages: | |||
- java | |||
products: | |||
- azure | |||
- azure-data-schemaregistry-avro | |||
- azure-event-hubs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is schema registry using event hubs tag?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
schema registry isn't a listed product in Taxonomy Service so the doc generation has an error.
schema registry is a sub-service of event hubs so I use this closest parent. If I'm wrong, we can use the root "azure".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As per offline discussion, schema registry isn't a sub service of eventhubs. Use "azure" for now until schema-registry itself is listed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It may not be, but that doesn't mean it's not related. These are slugs for where customers should see the sample, so if it's related, use the slug. These aren't categorizations of the sample, but a list of related products.
@@ -4,7 +4,7 @@ languages: | |||
- java | |||
products: | |||
- azure | |||
- azure-data-schemaregistry | |||
- azure-event-hubs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here - should this be reverted?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as above. Use "azure" only.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
storage side looks good to me
@@ -4,7 +4,6 @@ languages: | |||
- java | |||
products: | |||
- azure | |||
- azure-data-schemaregistry-avro |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not azure-event-hubs since it's related? It's not like this ties the sample to that, but shows up in more places. It's just a list of what's related.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The other languages have also already used this slug.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, I'll change to event-hubs to align with other languages. We can change it later if we have a new guideline.
@YijunXieMS When will you be merging this PR? It is currently blocking me from merging one of my PRs that I need to merge before I do a release tomorrow |
Merged. |
Thank you! |
"products" of sample README must be from the slugs of Taxonomy Service. Otherwise, the sample doc generation will have an error and won't proceed to process other SDKs' sample docs.
closes #20685