open-telemetry / open-telemetry/opentelemetry-ruby-contrib

RubyDoc updates not included in release process

Open
#877 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug keep
Dominant language
Ruby
Stars
137
Forks
258
Avg merge
3d 17h
Merged PRs (30d)
30

Description

We noticed recently the changes from #825 have not been applied to the RubyDoc page for the gem.

Look into the release process to see if something is broken/needs to be added to resume automated updates to the documentation.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the release process and the changes from #825 to find where RubyDoc updates stopped being applied. Confirm the automation path for the gem and identify what is missing or broken. Done means changes are again included in the published RubyDoc page during releases.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation, release
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.