apache / apache/storm

[STORM-3834] Fix ERROR and warnings creating java docs

Open
#7,616 0 comments 0 reactions 0 assignees View on GitHub
good first issue imported-jira-issue rfe
Dominant language
Java
Stars
6.7k
Forks
4k
Avg merge
1d 7h
Merged PRs (30d)
62

Description

Storm release steps require creating javadocs using the following command:


mvn javadoc:aggregate -DreportOutputDirectory=./docs/ -DdestDir=javadocs -Dnotimestamp=true -pl '!storm-shaded-deps


see: https://github.com/apache/storm-site/blob/asf-site/README.md

storm-site project is referred in https://github.com/apache/storm/blob/master/RELEASING.md

The maven command runs to completion, but had some ERROR and Warnings that should be fixed.

---
Originally reported by bipinprasad, imported from: Fix ERROR and warnings creating java docs


  • status: Open
  • priority: Major
  • resolution: Unresolved
  • imported: 2025-01-24

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the javadoc command in the issue and the release guidance in README.md and RELEASING.md. Run the documented Maven command, identify the reported ERROR and warning output, and verify that the release javadoc generation completes without those diagnostics.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
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.