elastic/logstash

Expand `rake version:sync` to also update asciidoc variables and the README.md

Open

#8,114 建立於 2017年8月31日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Ruby (14,197 star) (3,496 fork)batch import
docs infragood first issuehacktoberfest

描述

Update the documentation and the readme file is done manually by a human and this is error prone. We already have a rake task that take care of updating the version of the gems and also the dependencies requirements called rake version:sync.

We can expand this task to also take care of updating the following:

貢獻者指南

技術棧
rubyshell
領域
documentationbackenddevops
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
RubyRakeGit
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
The issue requires extending the existing `rake version:sync` task to also update asciidoc shared variables in docs/index shared1.asciidoc and version links in README.md. First, find the current implementation of `rake version:sync` in the Rakefile or lib/tasks. Then, identify the asciidoc variable file and README.md sections that contain version numbers. Modify the task to parse and update those files accordingly. The comment thread may provide guidance on expected format and how version numbers are currently managed.