Skip to content

Commit

Permalink
Drop docs folder and adjust links (open-telemetry#730)
Browse files Browse the repository at this point in the history
* Drop docs folder and adjust links

* Update PULL_REQUEST_TEMPLATE.md

* Add entry to CHANGELOG.md

* README: drop unused logo reference
  • Loading branch information
chalin authored and styblope committed Mar 12, 2023
1 parent 407f882 commit 11dd4b0
Show file tree
Hide file tree
Showing 43 changed files with 40 additions and 3,000 deletions.
5 changes: 3 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ For new features contributions please make sure you have completed the following
essential items:

* [ ] `CHANGELOG.md` updated to document new feature additions
* [ ] Appropriate documentation updates in the
[docs](https://github.com/open-telemetry/opentelemetry-demo/tree/main/docs) folder
* [ ] Appropriate documentation updates in the [docs][]

Maintainers will not merge until the above have been completed. If you're unsure
which docs need to be changed ping the
[@open-telemetry/demo-approvers](https://github.com/orgs/open-telemetry/teams/demo-approvers).

[docs]: https://opentelemetry.io/docs/demo/
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,3 +212,5 @@ significant modifications will be credited to OpenTelemetry Authors.
([#705](https://github.com/open-telemetry/opentelemetry-demo/pull/705))
* Enable exemplar support in the metrics exporter, Prometheus, and Grafana
([#704](https://github.com/open-telemetry/opentelemetry-demo/pull/704))
* [docs] Drop docs folder as step in migration to OTel website
([#729](https://github.com/open-telemetry/opentelemetry-demo/issues/729))
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Once the images are built and containers are started you can access:
The Demo team is committed to keeping the demo up to date. That means the
documentation as well as the code. When making changes to any service or feature
remember to find the related docs and update those as well. Most (but not all)
documentation can be found the [docs](./docs/) folder.
documentation can be found on the OTel website under [Demo docs][docs].

## Create Your First Pull Request

Expand Down Expand Up @@ -173,7 +173,7 @@ A PR is considered to be **ready to merge** when:
- Major feedbacks are resolved.
- It has been open for review for at least one working day. This gives people
reasonable time to review.
- The [documentation](./docs/) and [Changelog](./CHANGELOG.md) have been updated
- The [documentation][docs] and [Changelog](./CHANGELOG.md) have been updated
to reflect the new changes.
- Trivial changes (typo, cosmetic, doc, etc.) don't have to wait for one day.

Expand Down Expand Up @@ -208,3 +208,5 @@ Maintainers can create a new release when desired by following a few steps.
creating a new tag in the format `x.x.x` based on main. Automatically generate
release notes. Prepend a summary of the major changes to the release notes.
- Click 'Publish Release'.

[docs]: https://opentelemetry.io/docs/demo/
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![otel-photo](./docs/img/opentelemetry-logo-nav.png) OpenTelemetry Demo
# OpenTelemetry Demo

[![Slack](https://img.shields.io/badge/slack-@cncf/otel/demo-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03B4CWV4DA)
[![Version](https://img.shields.io/github/v/release/open-telemetry/opentelemetry-demo?color=blueviolet)](https://github.com/open-telemetry/opentelemetry-demo/releases)
Expand Down Expand Up @@ -29,22 +29,22 @@ OpenTelemetry across its languages in the future.
If you'd like to help (**which we would love**), check out our [contributing
guidance](./CONTRIBUTING.md).

If you'd like to extend this demo or maintain a fork of it, please read our
[fork guidance](./docs/forking.md).
If you'd like to extend this demo or maintain a fork of it, read our
[fork guidance](https://opentelemetry.io/docs/demo/forking/).

## Quick start

You can be up and running with the demo in a few minutes. Check out the docs for
your preferred deployment method:

- [Docker](./docs/docker_deployment.md)
- [Kubernetes](./docs/kubernetes_deployment.md)
- [Docker](https://opentelemetry.io/docs/demo/docker_deployment/)
- [Kubernetes](https://opentelemetry.io/docs/demo/kubernetes_deployment/)

## Documentation

We have detailed documentation available in the [docs](./docs/) folder. If you're
curious about a specific feature the docs [README](./docs/README.md) can point
you in the right direction.
For detailed documentation, see [Demo Documentation][docs]. If you're curious
about a specific feature, the [docs landing page][docs] can point you in the
right direction.

## Demos featuring the Astronomy Shop

Expand Down Expand Up @@ -93,3 +93,5 @@ Emeritus:
### Thanks to all the people who have contributed

[![contributors](https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-demo)](https://github.com/open-telemetry/opentelemetry-demo/graphs/contributors)

[docs]: https://opentelemetry.io/docs/demo/
29 changes: 21 additions & 8 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -351,13 +351,17 @@ services:
# Frontend Proxy (Envoy)
frontendproxy:
image: ${IMAGE_NAME}:${IMAGE_VERSION}-frontendproxy
container_name: frontend-proxy
build:
context: ./
dockerfile: src/frontendproxy/Dockerfile
args:
- INSTANA_AGENT_KEY=${INSTANA_AGENT_KEY}
- INSTANA_DOWNLOAD_KEY=${INSTANA_DOWNLOAD_KEY}
container_name: frontend-proxy
deploy:
resources:
limits:
memory: 50M
ports:
- "${ENVOY_PORT}:${ENVOY_PORT}"
- 10000:10000
Expand Down Expand Up @@ -428,7 +432,7 @@ services:
deploy:
resources:
limits:
memory: 70M
memory: 120M
restart: unless-stopped
ports:
- "${PAYMENT_SERVICE_PORT}"
Expand Down Expand Up @@ -582,7 +586,7 @@ services:
deploy:
resources:
limits:
memory: 200M
memory: 120M
restart: unless-stopped
environment:
- POSTGRES_USER=ffs
Expand All @@ -591,12 +595,12 @@ services:
- INSTANA_SERVICE_NAME=ffs_postgres
# command: ["-c", "track_activities=on", "-c", "track_counts=on", "-c", "track_io_timing=on"]
# The above way of passing paramaeters ins't picked up by Instana. Must use config file :(
logging: *logging
healthcheck:
test: ["CMD-SHELL", "pg_isready -d ffs -U ffs"]
interval: 10s
timeout: 5s
retries: 5
logging: *logging

# Kafka used by Checkout, Accounting, and Fraud Detection services
kafka:
Expand All @@ -610,7 +614,7 @@ services:
deploy:
resources:
limits:
memory: 800M
memory: 750M
restart: unless-stopped
environment:
- KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092
Expand All @@ -620,13 +624,14 @@ services:
- OTEL_RESOURCE_ATTRIBUTES
- OTEL_SERVICE_NAME=kafka
- INSTANA_SERVICE_NAME=kafka
logging: *logging
- KAFKA_HEAP_OPTS=-Xmx400m -Xms400m
healthcheck:
test: nc -z kafka 9092
start_period: 10s
interval: 5s
timeout: 10s
retries: 10
logging: *logging

# Redis used by Cart service
redis-cart:
Expand Down Expand Up @@ -662,7 +667,7 @@ services:
deploy:
resources:
limits:
memory: 275M
memory: 300M
restart: unless-stopped
ports:
- "${JAEGER_SERVICE_PORT}" # Jaeger UI
Expand All @@ -676,6 +681,10 @@ services:
grafana:
image: grafana/grafana:9.1.0
container_name: grafana
deploy:
resources:
limits:
memory: 75M
volumes:
- ./src/grafana/grafana.ini:/etc/grafana/grafana.ini
- ./src/grafana/provisioning/:/etc/grafana/provisioning/
Expand All @@ -690,7 +699,7 @@ services:
deploy:
resources:
limits:
memory: 100M
memory: 125M
restart: unless-stopped
command: [ "--config=/etc/otelcol-config.yml", "--config=/etc/otelcol-config-extras.yml" ]
volumes:
Expand Down Expand Up @@ -728,6 +737,10 @@ services:
- --enable-feature=exemplar-storage
volumes:
- ./src/prometheus/prometheus-config.yaml:/etc/prometheus/prometheus-config.yaml
deploy:
resources:
limits:
memory: 300M
ports:
- "${PROMETHEUS_SERVICE_PORT}:${PROMETHEUS_SERVICE_PORT}"
logging: *logging
Expand Down
84 changes: 0 additions & 84 deletions docs/README.md

This file was deleted.

Loading

0 comments on commit 11dd4b0

Please sign in to comment.