Skip to content

Remove unused links from docset.yml and fix links #753

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

Merged
merged 2 commits into from
Mar 12, 2025
Merged

Conversation

bmorelli25
Copy link
Member

No description provided.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR removes a large number of unused and outdated links from the docset configuration and fixes link formatting issues in several markdown documentation files.

  • Removed obsolete links from docset.yml to streamline the documentation source.
  • Updated rollover API link formatting in fleet data streams scenario documents.
  • Revised the Sysmon integration link in the auditbeat migration guide for improved clarity.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
docset.yml Removed multiple unused/outdated link entries to simplify the docset configuration.
reference/ingestion-tools/fleet/data-streams-scenario1.md Fixed rollover API link formatting to use explicit URLs.
reference/ingestion-tools/fleet/data-streams-scenario2.md Corrected rollover API link formatting with explicit markdown links.
reference/ingestion-tools/fleet/migrate-auditbeat-to-agent.md Updated the Sysmon integration link for clarity in reference documentation.
Comments suppressed due to low confidence (2)

docset.yml:66

  • Ensure that the removal of unused links (such as the functionbeat-ref entry) does not break any existing references within the documentation.
-  functionbeat-ref:   "https://www.elastic.co/guide/en/beats/functionbeat/current"

reference/ingestion-tools/fleet/data-streams-scenario1.md:76

  • The use of the placeholder '{{es}}' before the rollover API link may lead to unresolved values; consider verifying that this placeholder is intended or removing it if not needed.
New ILM policies only take effect when new indices are created, so you either must wait for a rollover to occur (usually after 30 days or when the index size reaches 50 GB), or force a rollover of each data stream using the {{es}} [rollover API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover).

Comment on lines +72 to 73
New ILM policies only take effect when new indices are created, so you either must wait for a rollover to occur (usually after 30 days or when the index size reaches 50 GB), or force a rollover of the data stream using the {{es}} [rollover API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover):

Copy link
Preview

Copilot AI Mar 12, 2025

Choose a reason for hiding this comment

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

Similarly, the '{{es}}' placeholder before the rollover API link should be checked to ensure it renders as intended or is removed for clarity.

Suggested change
New ILM policies only take effect when new indices are created, so you either must wait for a rollover to occur (usually after 30 days or when the index size reaches 50 GB), or force a rollover of the data stream using the {{es}} [rollover API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover):
New ILM policies only take effect when new indices are created, so you either must wait for a rollover to occur (usually after 30 days or when the index size reaches 50 GB), or force a rollover of the data stream using the [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current) [rollover API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover):

Copilot uses AI. Check for mistakes.

Copy link
Member Author

Choose a reason for hiding this comment

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

I appreciate the suggestion, but no.

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

@bmorelli25 bmorelli25 merged commit e9d1726 into main Mar 12, 2025
3 checks passed
@bmorelli25 bmorelli25 deleted the apm-bash branch March 12, 2025 15:49
thekofimensah pushed a commit that referenced this pull request Mar 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants