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

[In testing]Sync eng/common update doc logic 4985 for test pipeline #33109

Conversation

sima-zhu
Copy link
Contributor

Contributing to the Azure SDK

Please see our CONTRIBUTING.md if you are not familiar with contributing to this repository or have questions.

For specific information about pull request etiquette and best practices, see this section.

@sima-zhu sima-zhu changed the title Sync eng/common update doc logic 4985 for test pipeline [In testing]Sync eng/common update doc logic 4985 for test pipeline Dec 19, 2022
ghost pushed a commit to Azure/azure-sdk-tools that referenced this pull request Dec 21, 2022
**Problem**:
For package which is not "New" to csv, we have to use package.json to onboard the package. However, the best practice is to depend on csv file as many as possible. The PR change here is to add flexibility to use csv to onboard a new package.

**New onboard rule:**
1. If package sets "New" to true, then we will onboard the package.
2. If package sets some value to "MSDocService", then we will onboard the package. 
3. If nothing set for these two fields, then the package will not onboard to Docs.Ms.

**Pros:**
In this way, we can also push people to update `ms.service` as many as possible. If somehow we don't have the right `ms.service`, then we can use `placeholder` for temporary placement.

Testing onboarding logic:
1. Testing in Java, removed the `durabletask-azure-functions` in [package.json](https://github.com/azure-sdk/azure-docs-sdk-java/blob/main/package.json)
2. `durabletask-azure-functions` in csv is having `functions` in `MsDocService`, and `false` in `New`.
3. After docindex pipeline, the changes show up here: https://github.com/Azure/azure-docs-sdk-java/blob/daily/2022-12-15/package.json#L1054
<img width="544" alt="image" src="https://user-images.githubusercontent.com/48036328/208503572-d292b6a6-1eec-41f1-b112-b37e7d8307a6.png">

Testing on deprecated message:
1. .NET testing PR: Azure/azure-sdk-for-net#33109
2. Testing on review site: https://review.learn.microsoft.com/en-us/dotnet/api/overview/azure/storage?view=azure-dotnet&branch=daily%2F2022-12-15-ci-succeeded
<img width="321" alt="image" src="https://user-images.githubusercontent.com/48036328/208749147-61c46ea3-5f58-489a-ac02-bd9e54ad6c55.png">
@weshaggard weshaggard closed this Feb 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants