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

[doc] Add example to cross-plugin-concepts #12672

Merged
merged 5 commits into from
Apr 13, 2021

Conversation

roaksoax
Copy link
Contributor

@roaksoax roaksoax commented Feb 16, 2021

Adds an example showing users how to use the environment variable to define multiple whitespace-delimited URIs

What does this PR do?

Adds an example of how to use this functionality in an environment variable.

Why is it important/What is the impact to the user?

It is important because the current documentation is not clear enough and is confusing users as to how to use this behavior.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files (and/or docker env variables)
  • I have added tests that prove my fix is effective or that my feature works

Related issues

Closes #12661

Adds an example showing users how to use the environment variable to define multiple whitespace-delimited URIs
@roaksoax roaksoax requested a review from karenzone February 16, 2021 15:32
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

Thank you so much for expanding this section with a good example. I left a suggestion for minor wording tweaks inline.

docs/static/cross-plugin-concepts.asciidoc Outdated Show resolved Hide resolved
docs/static/cross-plugin-concepts.asciidoc Outdated Show resolved Hide resolved
@roaksoax roaksoax requested a review from karenzone March 8, 2021 14:42
@karenzone
Copy link
Contributor

This comment from yesterday was nested under an earlier review comment, and is easy to miss.
#12672 (comment)

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

Suggestion inline for your consideration. Please let me know if you would like to discuss.

docs/static/cross-plugin-concepts.asciidoc Outdated Show resolved Hide resolved
@roaksoax roaksoax requested a review from karenzone April 13, 2021 14:17
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

LGTM

@roaksoax roaksoax merged commit 2caea13 into master Apr 13, 2021
@roaksoax roaksoax deleted the add_example_to_cross-plugin-concepts branch April 13, 2021 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[doc] Unclear docs on supporting multiple hosts in an environment variable.
2 participants