elastic/logstash

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

Open

#8,114 opened on Aug 31, 2017

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

Repository metrics

Stars
 (14,197 stars)
PR merge metrics
 (Avg merge 4d 15h) (51 merged PRs in 30d)

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

Research direction
Examine the existing `rake version:sync` task in the Rakefile, then locate the asciidoc shared variables file and README links that need updating, and implement automation for those changes.
Tech stack
ruby
Domain
documentationtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Ruby
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70