apache / apache/accumulo-website
Website only hosts public API javadocs
- Dominant language
- HTML
- Stars
- 19
- Forks
- 133
- Avg merge
- 9h 37m
- Merged PRs (30d)
- 4
Description
The accumulo website only hosts the public API javadocs.
This is problematic as the website link does not have verbiage that describes these javadocs are only scoped to the public API classes.
Looking at javadoc.io, there is a clear difference between the package index available between the 2.1.3 versions of accumulo.
https://accumulo.apache.org/docs/2.x/apidocs/allpackages-index.html
https://www.javadoc.io/doc/org.apache.accumulo/accumulo-core/2.1.3/allpackages-index.html
Contributor guide
Research direction
Start by comparing the website's 2.x apidocs/allpackages-index.html with the linked javadoc.io 2.1.3 package index. Clarify whether the intended change is explanatory wording or broader documentation coverage, then update the website so visitors can tell what the hosted javadocs include.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jekyll
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100