Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove broken opentracing example for now #1467

Merged
merged 1 commit into from
Mar 22, 2021

Conversation

ciarams87
Copy link
Member

@ciarams87 ciarams87 commented Mar 19, 2021

Proposed changes

This commit remove the broken Opentracing example. The example will be re-added when it can be fixed and verified as working correctly.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto master
  • I will ensure my PR is targeting the master branch and pulling from my branch from my own fork

@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Mar 19, 2021
@pleshakov
Copy link
Contributor

@ciarams87 there are few references from the docs. could you remove them?

./docs-web/configuration/global-configuration/configmap-resource.md:408:     - `Support for OpenTracing <https://github.com/nginxinc/kubernetes-ingress/blob/master/examples/opentracing/README.md>`_.
./docs-web/configuration/global-configuration/configmap-resource.md:412:     - `Support for OpenTracing <https://github.com/nginxinc/kubernetes-ingress/blob/master/examples/opentracing/README.md>`_.
./docs-web/configuration/global-configuration/configmap-resource.md:416:     - `Support for OpenTracing <https://github.com/nginxinc/kubernetes-ingress/blob/master/examples/opentracing/README.md>`_.
./docs-web/third-party-modules/opentracing.md:5:This document explains how to use OpenTracing with the Ingress Controller. Additionally, we have an [example](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/opentracing) on how to enable OpenTracing for a simple web application using Jaeger as a tracer.

Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

this is needed to be cherry picked to the release branch, right?

@ciarams87 ciarams87 merged commit 489b721 into master Mar 22, 2021
@ciarams87 ciarams87 deleted the remove-broken-example branch March 30, 2021 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants