From e372ce5ee7d2bfecafd633688e702050759dca04 Mon Sep 17 00:00:00 2001 From: James Peach Date: Sat, 2 Jul 2022 05:54:20 +1000 Subject: [PATCH] Update docs to use relative code links. (#1447) --- ci/docfx.json | 2 ++ docs/dependencies.md | 27 +++++++++++++-------------- docs/google-test.md | 2 +- 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/ci/docfx.json b/ci/docfx.json index bc026d6232..cbf1b3027f 100644 --- a/ci/docfx.json +++ b/ci/docfx.json @@ -13,6 +13,8 @@ "files": [ "api/**.h", "api/**.cc", + "exporters/**.h", + "exporters/**.cc", "sdk/**.h", "sdk/**.cc" ] diff --git a/docs/dependencies.md b/docs/dependencies.md index 1a5d1d0f28..4cd4d39a5f 100644 --- a/docs/dependencies.md +++ b/docs/dependencies.md @@ -10,19 +10,18 @@ Both these dependencies are listed here: ## Internal dependencies -- [nostd::variant](https://github.com/open-telemetry/opentelemetry-cpp/blob/v1.0.0-rc1/api/include/opentelemetry/nostd/absl/types/variant.h): +- [nostd::variant](/api/include/opentelemetry/nostd/internal/absl/types/variant.h): This is backported from [Abseil C++ libraries](https://github.com/abseil/abseil-cpp) and used as default variant implementation. License: `Apache License 2.0` -- [TraceLoggingDynamic](https://github.com/open-telemetry/opentelemetry-cpp/blob/v1.0.0-rc1/exporters/etw/include/opentelemetry/exporters/etw/TraceLoggingDynamic.h): - Dynamic TraceLogging Provider API for C++ used by ETW exporter. License: `MIT - License` +- [TraceLoggingDynamic](/exporters/etw/include/opentelemetry/exporters/etw/TraceLoggingDynamic.h): + Dynamic TraceLogging Provider API for C++ used by ETW exporter. License: `MIT License` ## External dependencies -- [API](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/api) +- [API](/api) & - [SDK](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/sdk): + [SDK](/sdk): - Uses Standard C++ library for latest features (std::string_view, std::variant, std::span, std::shared_ptr, std::unique_ptr) with C++14/17/20 compiler if `WITH_STL` cmake option is enabled or `HAVE_CPP_STDLIB` macro is @@ -36,7 +35,7 @@ Both these dependencies are listed here: `--//api:with_abseil=true`) bazel option is enabled. License: `Apache License 2.0` -- [OTLP/HTTP+JSON](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/otlp) +- [OTLP/HTTP+JSON](/exporters/otlp) exporter: - [protobuf](https://github.com/protocolbuffers/protobuf): Library to serialize structured data. @@ -60,19 +59,19 @@ Both these dependencies are listed here: library. - License: `MIT License` -- [OTLP/gRPC](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/otlp) +- [OTLP/gRPC](/exporters/otlp) exporter: - `protobuf` OTLP messages are constructed as protobuf payloads. - [gRPC](https://github.com/grpc/grpc): An RPC library and framework - Exporter communicates with OTLP collector using gRPC transport mechanism. - License: `Apache License 2.0` -- [Zipkin](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/zipkin) +- [Zipkin](/exporters/zipkin) exporter: - `libcurl` for connecting with Zipkin server over HTTP protocol. - `nlohmann/json` for encoding Zipkin messages. -- [Jaeger](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/jaeger) +- [Jaeger](/exporters/jaeger) exporter: - [Thrift](https://github.com/apache/thrift) - Serialization and RPC framework. @@ -81,21 +80,21 @@ Both these dependencies are listed here: sent to remote Jaeger service. - License: `Apache License 2.0` -- [ETW](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/etw) +- [ETW](/exporters/etw) exporter: - `nlohmann/json` for generating MessagePack serialization for message to be transmitted to ETW. -- [Prometheus](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/prometheus) +- [Prometheus](/exporters/prometheus) exporter: - [`prometheus-cpp`](https://github.com/jupp0r/prometheus-cpp) Prometheus Client Library for Modern C++ - License: `MIT License` -- [ElasticSearch](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/elasticsearch) +- [ElasticSearch](/exporters/elasticsearch) exporter: - `libcurl` for connecting with Elasticsearch server over HTTP protocol. - `nlohmann/json` for encoding Elastic Search messages. -- [Zpages](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/ext/src/zpages): +- [Zpages](/ext/src/zpages): - None diff --git a/docs/google-test.md b/docs/google-test.md index fc9aa3f675..dadf5b1577 100644 --- a/docs/google-test.md +++ b/docs/google-test.md @@ -109,7 +109,7 @@ and dependencies. Along with a `BUILD` file, a `WORKSPACE` file exists that identifies the directory it resides in as a bazel workspace. In the OTel C++ repository, the SDK unit tests using the Google Test framework to ensure code functionality. In the -[BUILD](https://github.com/open-telemetry/opentelemetry-cpp/tree/master/sdk/test/trace) +[BUILD](/sdk/test/trace) file for trace tests, there are six different targets, each corresponding to a different unit test. An example target taken from this file is shown below.