Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Aggregated javadoc and docs URLs updates #8171

Merged

Conversation

romain-grecourt
Copy link
Contributor

@romain-grecourt romain-grecourt commented Dec 19, 2023

Description

Uptake build-tools 4.0.2

  • Use new helidon-javadoc-maven-pluging to generate aggregated javadocs
  • Use updated sitegen-maven-plugin to use proper SEO friendly URLs

Refactor docs to docs/src/main/asciidoc

  • Added a README to document new steps for building and serving the docs locally

Added a new top-level artifact helidon-all that is a "bundle" for all Helidon artifacts

  • 1:1 with helidon-bom but as proper dependencies
  • Can be used for build-time tooling (E.g. aggregated javadocs, config docs processor, dependency convergence, docker caching etc.)

Fixed various javadoc warnings.

Fixes #7870

Documentation

This PR does refactor the docs themselves and includes a README with instructions on how to build and serve the docs locally.

@romain-grecourt romain-grecourt added docs 4.x Version 4.x labels Dec 19, 2023
@romain-grecourt romain-grecourt added this to the 4.0.2 milestone Dec 19, 2023
@romain-grecourt romain-grecourt self-assigned this Dec 19, 2023
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Dec 19, 2023
Uptake build-tools 4.0.2
 - Use new helidon-javadoc-maven-pluging to generate aggregated javadocs
 - Use updated sitegen-maven-plugin to use proper SEO friendly URLs

Refactor docs to docs/src/main/asciidoc
 - Added a README to document new steps for building and serving the docs locally

Added a new top-level artifacts helidon-all that is a "bundle" for all Helidon artifacts
 - 1:1 with helidon-bom but as proper dependencies
 - Can be used for build-time tooling (E.g. aggregated javadocs, config docs processor, docker caching etc.)

Fixed various javadoc warnings.

Fixes helidon-io#7870
Copy link
Member

@barchetta barchetta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bravo!

@romain-grecourt romain-grecourt merged commit 99ab65c into helidon-io:main Dec 20, 2023
12 checks passed
@romain-grecourt romain-grecourt deleted the fix-aggregated-javadocs branch December 20, 2023 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4.x Version 4.x docs OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4.x: Missing javadocs for io.helidon.webserver.WebServerConfig.Builder
2 participants