Taking the parameter literally

[sima-zhu]

Description

We now have doc validation step in unified pipeline and release pipeline.
The PR is to implement the validation function in each language.

We also have docindex pipeline for all package validation. Make some changes to make it work.

All SDK Contribution checklist:

• The pull request does not introduce [breaking changes]
• CHANGELOG is updated for new features, bug fixes or other significant changes.
• I have read the contribution guidelines.

General Guidelines and Best Practices

• Title of the pull request is clear and informative.
• There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

• Pull request includes test coverage for the included changes.

[check-enforcer]

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run java - [service] - ci

[benbp]

$DocValidationImageId appears unused in both function signatures.

[sima-zhu]

It is a placeholder. Our java docker image is broken. I will fix the image first before we adding the real logic

[benbp]

Not related to your changes here but a more general comment: as someone reviewing who isn't aware of the context of what you're working on, it would be helpful to have a more descriptive PR title and/or description of the changes (initial issue, intent of the change, problems fixed, decisions made, etc.).

[sima-zhu]

Not related to your changes here but a more general comment: as someone reviewing who isn't aware of the context of what you're working on, it would be helpful to have a more descriptive PR title and/or description of the changes (initial issue, intent of the change, problems fixed, decisions made, etc.).

@benbp Add description as you suggested.