Skip to content

[8.x] Update docs version of reference.yml and improve header section (backport #1416)#1422

Merged
kilfoyle merged 1 commit into8.xfrom
mergify/bp/8.x/pr-1416
Nov 4, 2024
Merged

[8.x] Update docs version of reference.yml and improve header section (backport #1416)#1422
kilfoyle merged 1 commit into8.xfrom
mergify/bp/8.x/pr-1416

Conversation

@mergify
Copy link
Copy Markdown
Contributor

@mergify mergify bot commented Nov 4, 2024

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


This is an automatic backport of pull request #1416 done by [Mergify](https://mergify.com).

* 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 mergify bot requested a review from a team as a code owner November 4, 2024 15:02
@mergify mergify bot added the backport label Nov 4, 2024
@github-actions
Copy link
Copy Markdown

github-actions bot commented Nov 4, 2024

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.

@kilfoyle
Copy link
Copy Markdown
Member

kilfoyle commented Nov 4, 2024

@elasticmachine run docs-build

@kilfoyle kilfoyle merged commit b0cec92 into 8.x Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant