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

Update docs version of reference.yml and improve header section #1416

Merged
merged 2 commits into from
Nov 4, 2024

Conversation

kilfoyle
Copy link
Contributor

We had feedback on the Reference YAML docs page asking where to find a description of each field.

This PR:

  • Refreshes the embedded elastic-agent.reference.yml file with the version from 8.16.
  • Updates the paragraph at the top with links to the original version of the file in the elastic-agent repo, and to the docs section where the setting descriptions live.

Closes: https://github.com/elastic/docs-feedback/issues/47


Screenshot 2024-10-31 at 1 39 46 PM

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

cmacknz
cmacknz previously approved these changes Nov 1, 2024
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

@kilfoyle kilfoyle merged commit f5344bf into elastic:main Nov 4, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Nov 4, 2024
* Update docs version of reference.yml and improve header section

* Update docs/en/ingest-management/elastic-agent/configuration/yaml/elastic-agent-reference-yaml.asciidoc

(cherry picked from commit f5344bf)
mergify bot pushed a commit that referenced this pull request Nov 4, 2024
* Update docs version of reference.yml and improve header section

* Update docs/en/ingest-management/elastic-agent/configuration/yaml/elastic-agent-reference-yaml.asciidoc

(cherry picked from commit f5344bf)
kilfoyle added a commit that referenced this pull request Nov 4, 2024
… (#1423)

* Update docs version of reference.yml and improve header section

* Update docs/en/ingest-management/elastic-agent/configuration/yaml/elastic-agent-reference-yaml.asciidoc

(cherry picked from commit f5344bf)

Co-authored-by: David Kilfoyle <[email protected]>
kilfoyle added a commit that referenced this pull request Nov 4, 2024
… (#1422)

* Update docs version of reference.yml and improve header section

* Update docs/en/ingest-management/elastic-agent/configuration/yaml/elastic-agent-reference-yaml.asciidoc

(cherry picked from commit f5344bf)

Co-authored-by: David Kilfoyle <[email protected]>
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.

3 participants