Skip to content

Commit

Permalink
Remove old doc pages, point to docs directly (#5524)
Browse files Browse the repository at this point in the history
  • Loading branch information
atoulme authored Oct 18, 2024
1 parent ad6dd81 commit 1a288a6
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 42 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@
  •  
<a href="docs/components.md">Components</a>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="docs/monitoring.md">Monitoring</a>
<a href="https://docs.splunk.com/observability/en/gdi/opentelemetry/opentelemetry.html#otel-monitoring">Monitoring</a>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="docs/security.md">Security</a>
<a href="https://docs.splunk.com/Observability/gdi/opentelemetry/security.html">Security</a>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="docs/sizing.md">Sizing</a>
<a href="https://docs.splunk.com/Observability/gdi/opentelemetry/sizing.html">Sizing</a>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="docs/troubleshooting.md">Troubleshooting</a>
</strong>
Expand Down Expand Up @@ -85,18 +85,18 @@ The following resources are available:

- [Architecture](docs/architecture.md): How the Collector can be deployed
- [Components](docs/components.md): What the Collector supports with links to documentation
- [Monitoring](docs/monitoring.md): How to ensure the Collector is healthy
- [Security](docs/security.md): How to ensure the Collector is secure
- [Sizing](docs/sizing.md): How to ensure the Collector is properly sized
- [Monitoring](https://docs.splunk.com/observability/en/gdi/opentelemetry/opentelemetry.html#otel-monitoring): How to ensure the Collector is healthy
- [Security](https://docs.splunk.com/Observability/gdi/opentelemetry/security.html): How to ensure the Collector is secure
- [Sizing](https://docs.splunk.com/Observability/gdi/opentelemetry/sizing.html): How to ensure the Collector is properly sized
- [Troubleshooting](docs/troubleshooting.md): How to resolve common issues

All you need to get started is:

- [Splunk Access Token](https://docs.splunk.com/observability/admin/authentication/authentication-tokens/org-tokens.html)
- [Splunk Realm](https://dev.splunk.com/observability/docs/realms_in_endpoints/)
- [Agent or Gateway mode](docs/agent-vs-gateway.md)
- [Agent or Gateway mode](https://docs.splunk.com/Observability/gdi/opentelemetry/deployment-modes.html)
- [Confirm exposed
ports](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/security.md#exposed-endpoints)
ports](https://docs.splunk.com/Observability/gdi/opentelemetry/exposed-endpoints.html)
to make sure your environment doesn't have conflicts and that firewalls are
configured properly. Ports can be changed in the collector's configuration.

Expand Down Expand Up @@ -255,7 +255,7 @@ In order to use the upstream OpenTelemetry Collector:
- Properly configure the Collector for your particular metrics, traces, and logs use cases, as only a minimal default configuration is provided by the contrib release.

An example configuration for upstream, that ensures [infrastructure
correlation](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/apm-infra-correlation.md)
correlation](https://docs.splunk.com/observability/en/metrics-and-metadata/relatedcontent-collector-apm.html)
is properly configured, is available
[here](https://github.com/signalfx/splunk-otel-collector/blob/main/cmd/otelcol/config/collector/upstream_agent_config.yaml).
<!--PRODUCT_DOCS-->
Expand Down
2 changes: 1 addition & 1 deletion deployments/ansible/roles/collector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Observability Cloud](https://www.splunk.com/en_us/observability.html).

- [Splunk Access Token](https://docs.splunk.com/observability/admin/authentication/authentication-tokens/org-tokens.html)
- [Splunk Realm](https://dev.splunk.com/observability/docs/realms_in_endpoints/)
- [Double-check exposed ports](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/security.md#exposed-endpoints)
- [Double-check exposed ports](https://docs.splunk.com/observability/en/gdi/opentelemetry/exposed-endpoints.html)
to make sure your environment doesn't have conflicts. Ports can be changed in the collector's configuration.

## Usage
Expand Down
2 changes: 1 addition & 1 deletion deployments/chef/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ https://www.splunk.com/en_us/observability.html).

- [Splunk Access Token](https://docs.splunk.com/observability/admin/authentication/authentication-tokens/org-tokens.html)
- [Splunk Realm](https://dev.splunk.com/observability/docs/realms_in_endpoints/)
- [Double-check exposed ports](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/security.md#exposed-endpoints)
- [Double-check exposed ports](https://docs.splunk.com/observability/en/gdi/opentelemetry/exposed-endpoints.html)
to make sure your environment doesn't have conflicts. Ports can be changed in the collector's configuration.

## Linux
Expand Down
2 changes: 1 addition & 1 deletion deployments/salt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Currently, the following Linux distributions and versions are supported:

- [Splunk Access Token](https://docs.splunk.com/observability/admin/authentication/authentication-tokens/org-tokens.html)
- [Splunk Realm](https://dev.splunk.com/observability/docs/realms_in_endpoints/)
- [Double-check exposed ports](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/security.md#exposed-endpoints)
- [Double-check exposed ports](https://docs.splunk.com/observability/en/gdi/opentelemetry/exposed-endpoints.html)
to make sure your environment doesn't have conflicts. Ports can be changed in the collector's configuration.

## Usage
Expand Down
4 changes: 0 additions & 4 deletions docs/agent-vs-gateway.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/apm-infra-correlation.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/glossary.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/monitoring.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/security.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/sizing.md

This file was deleted.

0 comments on commit 1a288a6

Please sign in to comment.