spring-cloud / spring-cloud/spring-cloud-build
Add automation for projects to create javadoc links
Open
Nobody has claimed this yet.
task
- Dominant language
- Shell
- Stars
- 225
- Forks
- 295
- Avg merge
- 18h 57m
- Merged PRs (30d)
- 14
Description
This nice little service http://javadoc.io/ could be used to render our javadocs, but there are multiple jars per project. So there are 2 choices:
- Make a new page in each project's documentation that lists links to all javadocs, one per jar
- Publish an aggregate jar and make it appear in http://javadoc.io/. For that to work we'd have to know a little bit about the internals of the service (does it support this kind of aggregation?).
Option 1 is easier for us, but option 2 is more convenient for users.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source files, tests, or entry points are named. Start by comparing the two proposed approaches and checking whether javadoc.io supports aggregate jars; done requires an agreed automation path that exposes all project javadocs through the service.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100