Skip to content

Commit

Permalink
doc: Update Docker setup instructions (#528)
Browse files Browse the repository at this point in the history
Setup instructions referred to opentelemetry-ruby. This change makes the instructions more specific for the contrib repo.
  • Loading branch information
kaylareopelle authored Jun 22, 2023
1 parent 4f4a6b0 commit a179192
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-<library_name>` - container environment scoped to a specific instrumentation library. See `docker-compose.yml` for available services.

To test using Docker:

Expand All @@ -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 <service-name> bundle install`
5. Run the tests
* `docker-compose run <service-name> bundle exec rake test`

## Processing and visualizing traces locally

Expand Down

0 comments on commit a179192

Please sign in to comment.