elastic / elastic/beats

doc improvement for Winlogbeat upgrade

Open
#43,795 2 comments 0 reactions 0 assignees View on GitHub
docs needs_team Stalled Winlogbeat
Dominant language
Go
Stars
12.7k
Forks
5k
Avg merge
2d 15m
Merged PRs (30d)
385

Description

**Describe the enhancement:**
Today, all Beats share a common [upgrade guide](https://www.elastic.co/guide/en/beats/libbeat/current/upgrading.html).
While it's easy to maintain and avoids duplicates, it misses some nuances when it comes to Winlogbeat specifically.

It'll be better if we can have dedicated Winlogbeat upgrade doc or at least add Winlogbeat specific notes to the existing doc.

A few feedbacks from the users:

- It's not clear whether it's required to remove the older version before the upgrade (both major/minor upgrade).
- It's also not totally clear what to backup before the upgrade (not "data and config directories" as mentioned in current common upgrade guide).

Contributor guide

Open the contributing guide

Research direction

Start with the linked shared Beats upgrade guide and review how Winlogbeat upgrades are currently described. Clarify whether older versions must be removed and exactly what users should back up; done means Winlogbeat-specific upgrade guidance answers both questions, either in the shared guide or a dedicated document.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.