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.

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

docs: clarify reloadable config option usage #15957

Merged
merged 3 commits into from
Jan 20, 2023
Merged

docs: clarify reloadable config option usage #15957

merged 3 commits into from
Jan 20, 2023

Conversation

jkirschner-hashicorp
Copy link
Contributor

Improvements:

  • Alter wording to make it more obvious when reading quickly that this is a list of reloadable options, not a list of non-reloadable option
  • Mention that auto-reload is possible and how to configure it

@jkirschner-hashicorp jkirschner-hashicorp added type/docs Documentation needs to be created/updated/clarified pr/no-changelog PR does not need a corresponding .changelog entry labels Jan 11, 2023
@jkirschner-hashicorp jkirschner-hashicorp requested a review from a team as a code owner January 11, 2023 17:42
trujillo-adam
trujillo-adam reviewed Jan 11, 2023
View reviewed changes
Copy link
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

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

Suggested a few tweaks.

website/content/docs/agent/config/index.mdx Outdated Show resolved Hide resolved
website/content/docs/agent/config/index.mdx Outdated Show resolved Hide resolved
trujillo-adam
trujillo-adam approved these changes Jan 20, 2023
View reviewed changes
Copy link
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

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

One thing to address, but approving so you can merge as soon as you're ready.

website/content/docs/agent/config/index.mdx Outdated

The following agent configuration options are reloadable at runtime:

Reloadable agent configuration options:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Reloadable agent configuration options:

I think this is redundant.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oops. Yeah ... That got in there by accident!

@jkirschner-hashicorp jkirschner-hashicorp merged commit 0611726 into main Jan 20, 2023
@jkirschner-hashicorp jkirschner-hashicorp deleted the docs/clarify-reloadable-config-option-usage branch January 20, 2023 23:42
This was referenced Jan 20, 2023
Merged
Merged
skpratt pushed a commit that referenced this pull request Jan 25, 2023
@jkirschner-hashicorp @skpratt
docs: clarify reloadable config option usage (#15957)
d4683fa
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trujillo-adam trujillo-adam trujillo-adam approved these changes

Assignees
No one assigned
Labels
pr/no-changelog PR does not need a corresponding .changelog entry type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jkirschner-hashicorp @trujillo-adam