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

Use taxonomy for service metadata #1442

Open
danieljurek opened this issue Feb 23, 2021 · 8 comments
Open

Use taxonomy for service metadata #1442

danieljurek opened this issue Feb 23, 2021 · 8 comments
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. Docs

Comments

@danieljurek
Copy link
Member

Our strategy for naming the service is currently: https://github.com/Azure/azure-sdk-tools/blob/master/eng/common/scripts/update-docs-metadata.ps1#L53

However there is an official taxonomy of names for services. We should use the names from that taxonomy and only generate the service name as a fallback when a taxonomy-compliant name is not found.

@danieljurek danieljurek added Docs Central-EngSys This issue is owned by the Engineering System team. labels Feb 23, 2021
@scbedd
Copy link
Member

scbedd commented Jun 28, 2021

For future reference for anyone else looking at this issue. Taxonomies are recorded here.

Unfortunately we can't simply reach out and pull HTML here, as it is not a publically available page.

@scbedd
Copy link
Member

scbedd commented Jun 28, 2021

Going to update our _releases/latest CSVs with a new column: DocsSlugId

@danieljurek
Copy link
Member Author

Recently heard from the docs team about this issue. @weshaggard -- Would the docs slug id that goes in the ms.service (example) field be a good fit for the release preparation script?

@weshaggard
Copy link
Member

As in you want folks to provide it when they run prepare-release? I suspect most folks will have no idea what value to give here. Ideally, we would derive it from one of our other pieces of metadata but if we cannot and it is unique, we can consider adding the value to the csv metadata file but we would need to figure out how to populate it.

@kurtzeborn
Copy link
Member

We now have some of the things we were thinking of in this issue already done. We are storing the data, we do verification similar to this for samples.

Keeping this open since we would still like this. Limited customer impact. Better grouping and searching probably which would help discovery. Reporting would also be improved.

@weshaggard
Copy link
Member

We might be able to share some of the contents of this script we are using to validate slugs for samples https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/scripts/Test-SampleMetadata.ps1

@JasonWHowell
Copy link

@JasonWHowell
Copy link

JasonWHowell commented Sep 8, 2023

The code mentioned overriding the default metatadata by adding entries into the CSV.

Thinking these are the packages to do the override in:
https://github.com/Azure/azure-sdk/edit/main/_data/releases/latest/ *.csv

The MSDocService column is near the far right in each .csv file: ... ,"MSDocService","ServiceId","Notes"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team. Docs
Projects
Development

No branches or pull requests

5 participants