elastic/logstash

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

Open

#8114 opened on Aug 31, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Ruby (14,197 stars) (3,496 forks)batch import
docs infragood first issuehacktoberfest

Description

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:

Contributor guide

Tech stack
rubyshell
Domain
documentationbackenddevops
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
RubyRakeGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.