From 6da0c670ba7007c5660689fe937c668d21b662bf Mon Sep 17 00:00:00 2001 From: Kayla Reopelle Date: Wed, 21 Jun 2023 15:27:04 -0700 Subject: [PATCH] doc: Update Docker setup instructions Setup instructions referred to opentelemetry-ruby. This change makes the instructions more specific for the contrib repo. --- CONTRIBUTING.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c49fe04d7..1c9acf194 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,6 +90,7 @@ The services provided include: * `app` - main container environment scoped to the `/app` directory. Used primarily to build and tag the `opentelemetry/opentelemetry-ruby-contrib:latest` image. + * `x-instrumentation-` - container environment scoped to a specific instrumentation library. See `docker-compose.yml` for available services. To test using Docker: @@ -98,16 +99,10 @@ To test using Docker: 3. Build the `opentelemetry/opentelemetry-ruby-contrib` image * `docker-compose build` * This makes the image available locally - 4. API: - 1. Install dependencies - * `docker-compose run api bundle install` - 2. Run the tests - * `docker-compose run api bundle exec rake test` - 5. SDK: - 1. Install dependencies - * `docker-compose run sdk bundle install` - 2. Run the tests for the sdk - * `docker-compose run sdk bundle exec rake test` + 4. Install dependencies for the service you want to interact with + * `docker-compose run bundle install` + 5. Run the tests + * `docker-compose run bundle exec rake test` ## Processing and visualizing traces locally