Skip to content

Commit

Permalink
docs: remove dead links to v1 and v2 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aboguszewski-sumo committed Nov 29, 2022
1 parent 97778ab commit 39bf8d5
Show file tree
Hide file tree
Showing 10 changed files with 6 additions and 25 deletions.
3 changes: 0 additions & 3 deletions deploy/docs/v1_conf_examples.md

This file was deleted.

3 changes: 0 additions & 3 deletions deploy/docs/v1_migration_doc.md

This file was deleted.

3 changes: 0 additions & 3 deletions deploy/docs/v2_migration_doc.md

This file was deleted.

7 changes: 5 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,18 @@ Documentation links:
- [Traces - auto-instrumentation in Kubernetes](https://help.sumologic.com/docs/apm/traces/get-started-transaction-tracing/opentelemetry-instrumentation/kubernetes)

- Upgrades
- [Upgrade from v0.17 to v1.0](/docs/v1-migration-doc.md)
- [Upgrade from v1.3 to v2.0](/docs/v2-migration-doc.md)
- [Upgrade from v0.17 to v1.0][migration-doc-v1]
- [Upgrade from v1.3 to v2.0][migration-doc-v2]

- [Migration steps from `SumoLogic/fluentd-kubernetes-sumologic`](/docs/migration-steps.md)
- [Troubleshooting Collection](/docs/troubleshoot-collection.md)
- [Monitoring the Monitoring](/docs/monitoring-lag.md)
- [Performance estimates for running collection chart](/docs/performance.md)
- [Dev Releases](/docs/dev.md)

[migration-doc-v1]: https://github.com/SumoLogic/sumologic-kubernetes-collection/blob/release-v2/deploy/docs/v1_migration_doc.md
[migration-doc-v2]: https://github.com/SumoLogic/sumologic-kubernetes-collection/blob/release-v2/deploy/docs/v2_migration_doc.md

## Solution overview

The diagram below illustrates the components of the Kubernetes collection solution.
Expand Down
2 changes: 0 additions & 2 deletions docs/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -621,8 +621,6 @@ fluentd:

You can find more information on the `grep` filter plugin in the
[fluentd documentation](https://docs.fluentd.org/filter/grep).
Refer to our [documentation](v1-conf-examples.md) for other examples of how you can
customize the fluentd pipeline.

## Modifying logs in Fluentd

Expand Down
2 changes: 0 additions & 2 deletions docs/existing-prometheus-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,8 +315,6 @@ helm upgrade --install my-release sumologic/sumologic -f user-values.yaml
## Upgrading Sumo Logic Collection

__Note, if you are upgrading to version 1.x of our collection from a version before 1.x, please see our [migration guide](v1-migration-doc.md).__

To upgrade our helm chart to a newer version, you must first run update your local helm repo.

```bash
Expand Down
3 changes: 0 additions & 3 deletions docs/non-helm-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,9 +321,6 @@ cat user-values.yaml | \
## Upgrading Sumo Logic Collection

**Note, if you are upgrading to version 1.x of our collection from a version before 1.x,
please see our [migration guide](v1-migration-doc.md).**

To upgrade you can simply re-generate the YAML when a new version
of the Kubernetes collection is available.
You can use the same commands used to create the YAML in the first place.
Expand Down
2 changes: 0 additions & 2 deletions docs/side-by-side-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,8 +370,6 @@ helm upgrade --install my-release sumologic/sumologic -f user-values.yaml
### Upgrading Sumo Logic Collection

**Note, if you are upgrading to version 1.x of our collection from a version before 1.x, please see our [migration guide](v1-migration-doc.md).**

To upgrade our helm chart to a newer version, you must first run update your local helm repo.

```bash
Expand Down
2 changes: 0 additions & 2 deletions docs/standalone-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,6 @@ helm upgrade --install my-release sumologic/sumologic -f user-values.yaml
## Upgrading Sumo Logic Collection

__Note, if you are upgrading to version 1.x of our collection from a version before 1.x, please see our [migration guide](v1-migration-doc.md).__

To upgrade our Helm chart to a newer version, you must first run update your local Helm repo.

```bash
Expand Down
4 changes: 1 addition & 3 deletions docs/troubleshoot-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -494,9 +494,7 @@ If you observe the following errors from Fluentd pods:
2021-01-18 15:47:23 +0000 [warn]: #0 [sumologic.endpoint.logs.gc] failed to flush the buffer. retry_time=3 next_retry_seconds=2021-01-18 15:47:27 +0000 chunk="5b92e97a5ee3cbd7e59859644d9686e3" error_class=Zlib::GzipFile::Error error="not in gzip format"
```

Please see [migration topic on that](v2-migration-doc.md#gzip-compression-errors).

If the problem still occurs, please disable gzip compression for buffer.
Please disable gzip compression for buffer.
Add following configuration to your `user-values.yaml` and upgrade collection:

```yaml
Expand Down

0 comments on commit 39bf8d5

Please sign in to comment.