Skip to content

Commit 1186a8d

Browse files
committed
Update docs to use relative code links.
Use relative links to locations within the same repository. This means that in the Github UI the reader will follow the link to the location in the same branch rather than to a fixed, predetermined branch. Signed-off-by: James Peach <jpeach@cloudflare.com>
1 parent 2f0a3d6 commit 1186a8d

2 files changed

Lines changed: 14 additions & 15 deletions

File tree

docs/dependencies.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,18 @@ Both these dependencies are listed here:
1010

1111
## Internal dependencies
1212

13-
- [nostd::variant](https://github.com/open-telemetry/opentelemetry-cpp/blob/v1.0.0-rc1/api/include/opentelemetry/nostd/absl/types/variant.h):
13+
- [nostd::variant](../api/include/opentelemetry/nostd/absl/types/variant.h):
1414
This is backported from [Abseil C++
1515
libraries](https://github.com/abseil/abseil-cpp) and used as default variant
1616
implementation. License: `Apache License 2.0`
17-
- [TraceLoggingDynamic](https://github.com/open-telemetry/opentelemetry-cpp/blob/v1.0.0-rc1/exporters/etw/include/opentelemetry/exporters/etw/TraceLoggingDynamic.h):
18-
Dynamic TraceLogging Provider API for C++ used by ETW exporter. License: `MIT
19-
License`
17+
- [TraceLoggingDynamic](../exporters/etw/include/opentelemetry/exporters/etw/TraceLoggingDynamic.h):
18+
Dynamic TraceLogging Provider API for C++ used by ETW exporter. License: `MIT License`
2019

2120
## External dependencies
2221

23-
- [API](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/api)
22+
- [API](../api)
2423
&
25-
[SDK](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/sdk):
24+
[SDK](../sdk):
2625
- Uses Standard C++ library for latest features (std::string_view,
2726
std::variant, std::span, std::shared_ptr, std::unique_ptr) with C++14/17/20
2827
compiler if `WITH_STL` cmake option is enabled or `HAVE_CPP_STDLIB` macro is
@@ -36,7 +35,7 @@ Both these dependencies are listed here:
3635
`--//api:with_abseil=true`) bazel option is enabled. License: `Apache
3736
License 2.0`
3837

39-
- [OTLP/HTTP+JSON](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/otlp)
38+
- [OTLP/HTTP+JSON](../exporters/otlp)
4039
exporter:
4140
- [protobuf](https://github.com/protocolbuffers/protobuf): Library to
4241
serialize structured data.
@@ -60,19 +59,19 @@ Both these dependencies are listed here:
6059
library.
6160
- License: `MIT License`
6261

63-
- [OTLP/gRPC](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/otlp)
62+
- [OTLP/gRPC](../exporters/otlp)
6463
exporter:
6564
- `protobuf` OTLP messages are constructed as protobuf payloads.
6665
- [gRPC](https://github.com/grpc/grpc): An RPC library and framework
6766
- Exporter communicates with OTLP collector using gRPC transport mechanism.
6867
- License: `Apache License 2.0`
6968

70-
- [Zipkin](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/zipkin)
69+
- [Zipkin](../exporters/zipkin)
7170
exporter:
7271
- `libcurl` for connecting with Zipkin server over HTTP protocol.
7372
- `nlohmann/json` for encoding Zipkin messages.
7473

75-
- [Jaeger](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/jaeger)
74+
- [Jaeger](../exporters/jaeger)
7675
exporter:
7776
- [Thrift](https://github.com/apache/thrift) - Serialization and RPC
7877
framework.
@@ -81,21 +80,21 @@ Both these dependencies are listed here:
8180
sent to remote Jaeger service.
8281
- License: `Apache License 2.0`
8382

84-
- [ETW](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/etw)
83+
- [ETW](../exporters/etw)
8584
exporter:
8685
- `nlohmann/json` for generating MessagePack serialization for message to be
8786
transmitted to ETW.
8887

89-
- [Prometheus](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/prometheus)
88+
- [Prometheus](../exporters/prometheus)
9089
exporter:
9190
- [`prometheus-cpp`](https://github.com/jupp0r/prometheus-cpp) Prometheus
9291
Client Library for Modern C++
9392
- License: `MIT License`
9493

95-
- [ElasticSearch](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/exporters/elasticsearch)
94+
- [ElasticSearch](../exporters/elasticsearch)
9695
exporter:
9796
- `libcurl` for connecting with Elasticsearch server over HTTP protocol.
9897
- `nlohmann/json` for encoding Elastic Search messages.
9998

100-
- [Zpages](https://github.com/open-telemetry/opentelemetry-cpp/tree/v1.0.0-rc1/ext/src/zpages):
99+
- [Zpages](../ext/src/zpages):
101100
- None

docs/google-test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ and dependencies. Along with a `BUILD` file, a `WORKSPACE` file exists that
109109
identifies the directory it resides in as a bazel workspace. In the OTel C++
110110
repository, the SDK unit tests using the Google Test framework to ensure code
111111
functionality. In the
112-
[BUILD](https://github.com/open-telemetry/opentelemetry-cpp/tree/master/sdk/test/trace)
112+
[BUILD](../sdk/test/trace)
113113
file for trace tests, there are six different targets, each corresponding to a
114114
different unit test. An example target taken from this file is shown below.
115115

0 commit comments

Comments
 (0)