Minor markdown fixes, link updates (#98)

Noticed some bugs in the recent changes from #92, fixed here.

Author: jmacd

CONTRIBUTING.md

@@ -1,8 +1,7 @@
 # Contributing to the OpenTelemetry Protocol with Apache Arrow project
 
 We want to make contributing to this project as easy and transparent
-as possible.  Please see the OpenTelemetry
-[CONTRIBUTING.md](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md)
+as possible.  Please see the OpenTelemetry [CONTRIBUTING.md][]
 guidelines for project-wide information, including code of conduct,
 and contributor license agreements, copyright notices, and how to
 engage with the OpenTelemetry community.
@@ -52,7 +51,7 @@ generated files present in the `./proto/api/collector/arrow/v1` directory.
 
 ### Releasing this repository
 
-See the instructions in [RELEASING.md][./RELEASING.md].
+See the instructions in [RELEASING.md][].
 
 ### Local development issues
 
@@ -75,6 +74,8 @@ the easiest way to upgrade this repository is:
 3. Regenerate `otelarrowcol` via `make genotelarrowcol`
 4. Run `go work sync` to update the other modules with fresh dependencies.
 
+[CONTRIBUTING.md]: ./CONTRIBUTING.md
+[RELEASING.md]: ./RELEASING.md
 [OTCDOCS]: https://opentelemetry.io/docs/collector/
 [OTCGH]: https://github.com/open-telemetry/opentelemetry-collector
 [OACGH]: https://github.com/open-telemetry/otel-arrow-collector

README.md

@@ -11,7 +11,7 @@ reference implementation.
 ## Quick start
 
 Instructions for building an OpenTelemetry Collector with the modules
-in this repository are provided in [`BUILDING.md`][./collector/BUILDING.md].
+in this repository are provided in [BUILDING.md][].
 
 Examples for running the OpenTelemetry Collector with the modules in
 this repository are documented in
@@ -175,8 +175,12 @@ data has not been updated and this collector is still fundamentally row-oriented
 
 Pull requests are welcome. For major changes, please open an issue
 first to discuss what you would like to change.  For more information, please
-read [CONTRIBUTING](CONTRIBUTING.md).
+read [CONTRIBUTING.md][].
 
 ## License
 
 OpenTelemetry Protocol with Apache Arrow Protocol Adapter is licensed under Apache 2.0.
+
+[CONTRIBUTING.md]: ./CONTRIBUTING.md
+[BUILDING.md]: ./BUILDING.md
+

collector/BUILDING.md

@@ -9,7 +9,7 @@ The recommended practice for building the OpenTelemetry Collector uses
 a [`builder` tool][BUILDER].  The builder synthesizes a Golang
 `go.mod` file and main package with a specific set of components.  If
 you are trying to modify and build code in this repository, see
-[../CONTRIBUTING.md][CONTRIBUTING], otherwise the instructions here
+[CONTRIBUTING.md][], otherwise the instructions here
 will help you simply build the code in order to try it out.
 
 ## Building a collector from local sources using an installed Golang toolchain
@@ -69,19 +69,13 @@ modified for integration into a custom build and release pipeline.
 With Docker installed, simply run:
 
 ```
-docker build . -t otelarrowcol
+make docker-otelarrowcol
 ```
 
-This command is also available as `make docker-otelarrowcol`.  You
-will be able to run the [examples][EXAMPLES] using the resulting
-`otelarrowcol` image, e.g.,
-
-```
-docker run otelarrowcol --config collector/examples/bridge/edge-collector.yaml
-```
+You will now be able to run the [examples][EXAMPLES] using the
+resulting `otelarrowcol` image.
 
 [BUILDER]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/builder/README.md
-[CONTRIBUTING]: ../CONTRIBUTING.md
+[CONTRIBUTING.md]: ../CONTRIBUTING.md
 [EXAMPLES]: ./examples/README.md
-[BUILDCONFIG]: ./cmd/otelarrowcol/build-config.yaml
-[GCPSAMPLE]: https://github.com/GoogleCloudPlatform/opentelemetry-collector-builder-sample
+[BUILDCONFIG]: ./otelarrowcol-build.yaml