Azure / Azure/azure-sdk-tools

Cleanup common docs processing files that use the docker image once the new docs tools are integrated.

Open
#7,645 0 comments 0 reactions 2 assignees Claimed by @JimSuplizio View on GitHub
Docs
Dominant language
C#
Stars
135
Forks
260
Avg merge
1d 22h
Merged PRs (30d)
115

Description

JS, Java, Net and Python are the languages that use the Docker Images for docs validation. New docs tools are being developed for by the docs teams that will allow us to remove the dependency on the docker images but the common scripts and yml files cannot be cleaned up until all of this work is done.

The items in eng/common that need to have DocValidationImageId processing removed are:

- [update-docsms-metadata.yml](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/pipelines/templates/steps/update-docsms-metadata.yml)
- [Update-DocsMsMetadata.ps1](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/scripts/Update-DocsMsMetadata.ps1)
- [Update-DocsMsPackages.ps1](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/scripts/Update-DocsMsPackages.ps1)

Being common, these are also going to require matching changes in the language repositories, specifically anything calling the ValidateDocsMsPackagesFn function pointer. Note: The language specific yml files that include the update-docsms-metadata.yml template should have their references to DocValidationImageId removed at the time the new docs generation tools are enabled for that language.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.