Skip to content

[DOCS] Clarifying env variable substitution #57370

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 5, 2020
Merged

[DOCS] Clarifying env variable substitution #57370

merged 4 commits into from
Jun 5, 2020

Conversation

lockewritesdocs
Copy link
Contributor

@lockewritesdocs lockewritesdocs commented May 29, 2020 •
edited
Loading

@lockewritesdocs lockewritesdocs added >docs General docs changes :Core/Infra/Core Core issues without another label Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team labels May 29, 2020
@lockewritesdocs lockewritesdocs self-assigned this May 29, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (:Core/Infra/Core)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

jrodewig
jrodewig previously requested changes May 29, 2020
View reviewed changes
Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

Looks good for the most part. Left some suggestions and tried to indicate what should be optional vs. not. Let me know if you have any questions!

@jrodewig
Update code snippet
eb82696 
Co-authored-by: James Rodewig <[email protected]>
DaveCTurner
DaveCTurner reviewed May 29, 2020
View reviewed changes
@jrodewig jrodewig dismissed their stale review May 30, 2020 12:44

Stale review.

@lockewritesdocs
Copy link
Contributor Author

@DaveCTurner, regarding this statement, is this modification closer to what we want to convey?

Values for environment variables must be simple strings. Use a comma-separated string to provide values that Elasticsearch will parse as a list. For example, Elasticsearch will split the following string into a list of values for the ${HOSTNAME} environment variable:

export HOSTNAME=“host1,host2"

@DaveCTurner
Copy link
Contributor

Yes @lockewritesdocs that looks good.

@lockewritesdocs lockewritesdocs merged commit 1e59868 into elastic:master Jun 5, 2020
@lockewritesdocs lockewritesdocs deleted the docs__clarify-env-variable-substitutions branch June 5, 2020 14:10
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jun 5, 2020
@jrodewig @DaveCTurner
[DOCS] Clarifying env variable substitution (elastic#57370)
d4fb071 
* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback

Co-authored-by: James Rodewig <[email protected]>
Co-authored-by: David Turner <[email protected]>
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jun 5, 2020
@jrodewig @DaveCTurner
[DOCS] Clarifying env variable substitution (elastic#57370)
59da9ba 
* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback

Co-authored-by: James Rodewig <[email protected]>
Co-authored-by: David Turner <[email protected]>
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jun 5, 2020
@jrodewig @DaveCTurner
[DOCS] [7.7] Clarifying env variable substitution (elastic#57370)
839c33b 
* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback

Co-authored-by: James Rodewig <[email protected]>
Co-authored-by: David Turner <[email protected]>
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jun 5, 2020
@jrodewig @DaveCTurner
[DOCS] Clarifying env variable substitution (elastic#57370)
3836afc 
* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback

Co-authored-by: James Rodewig <[email protected]>
Co-authored-by: David Turner <[email protected]>
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jun 5, 2020
@jrodewig @DaveCTurner
[DOCS] Clarifying env variable substitution (elastic#57370)
0b4873e 
* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback

Co-authored-by: James Rodewig <[email protected]>
Co-authored-by: David Turner <[email protected]>
lockewritesdocs pushed a commit that referenced this pull request Jun 5, 2020
[DOCS] Clarifying env variable substitution (#57370) (#57733)
b06b0da 
* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback
lockewritesdocs pushed a commit that referenced this pull request Jun 5, 2020
[DOCS] Clarifying env variable substitution (#57370) (#57734)
46df2c4 
* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback
lockewritesdocs pushed a commit that referenced this pull request Jun 5, 2020
[DOCS] [7.7] Clarifying env variable substitution (#57370) (#57736)
13258e0 
* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback
lockewritesdocs pushed a commit that referenced this pull request Jun 5, 2020
[DOCS] Clarifying env variable substitution (#57370) (#57737)
fe558f6 
* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback
lockewritesdocs pushed a commit that referenced this pull request Jun 5, 2020
[DOCS] Clarifying env variable substitution (#57370) (#57738)
b307eec 
* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jrodewig jrodewig jrodewig left review comments

@DaveCTurner DaveCTurner Awaiting requested review from DaveCTurner

Assignees

@lockewritesdocs lockewritesdocs

Labels
:Core/Infra/Core Core issues without another label >docs General docs changes Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Using environment variable for square brackets is not documented, not obvious
4 participants
@lockewritesdocs @elasticmachine @DaveCTurner @jrodewig