checkdoc

README

Documentation checker

Tool that checks the components enabled in OpenTelemetry core and contrib repos have the proper documentations.

Usage:

checkdoc --project-path path/to/project \
         --component-rel-path service/defaultcomponents/defaults.go \
         --module-name go.opentelemetry.io/collector

Deprecation note

This has been deprecated in favor of checkfile. Please use checkfile with argument --file-name README.md instead.

Documentation

Overview

Copyright The OpenTelemetry Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Deprecated: Please use checkfile with argument --file-name README.md instead.