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.

Sign up for GitHub

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

Jump to bottom

4.x Broken doc links #8181

Closed
romain-grecourt opened this issue Dec 22, 2023 · 3 comments
Closed

4.x Broken doc links #8181

romain-grecourt opened this issue Dec 22, 2023 · 3 comments
Assignees
@barchetta
Labels
4.x Version 4.x bug Something isn't working docs
Milestone
4.1.0

Comments

@romain-grecourt
Copy link
Contributor

romain-grecourt commented Dec 22, 2023 •
edited
Loading

Environment Details

  • Helidon Version: 4.0.2

Problem Description

See the list below (format is status url).

400 ../tracing.adoc
404 /apidocs/io.helidon.common.configurable/io.helidon.common.configurable/ScheduledThreadPoolSupplier.Builder.html#config(io.helidon.config.Config)
404 /apidocs/io.helidon.common.configurable/io.helidon.common.configurable/ThreadPoolSupplier.Builder.html#config(io.helidon.config.Config)
404 /apidocs/io.helidon.config/io/helidon/config/RetryPolicies.Builder.html
404 /apidocs/io.helidon.config/io/helidon/config/internal/FileConfigSource.FileBuilder.html
404 /apidocs/io.helidon.config/io/helidon/config/spi/AbstractConfigSourceBuilder.html
404 /apidocs/io.helidon.config/io/helidon/config/spi/AbstractParsableConfigSource.Builder.html#init-io.helidon.config.Config-
404 /apidocs/io.helidon.config/io/helidon/config/yaml/YamlConfigParser.html
404 /apidocs/io.helidon.config/io/helidon/configRetryPolicies.html#repeat-int-
404 /apidocs/io.helidon.integrations.openapi.ui/io/helidon/integrations/openapi/ui/OpenApiUi.Builder.html
404 /apidocs/io.helidon.metrics.api/Counter.html
404 /apidocs/io.helidon.metrics.api/DistributionSummary.html
404 /apidocs/io.helidon.metrics.api/Gauge.html
404 /apidocs/io.helidon.metrics.api/MeterRegistry.html
404 /apidocs/io.helidon.metrics.api/Timer.html
404 /apidocs/io.helidon.metrics.prometheus/PrometheusSupport.Builder.html
 /apidocs/io.helidon.microprofile.cors/io/helidon/microprofile/cors/CrossOrigin.html}
404 /apidocs/io.helidon.microprofile.metrics/RegistryFactory.html
404 /apidocs/io.helidon.openapi/OpenApiFeature.Builder.html
404 /apidocs/io.helidon.openapi/io.helidon.openapi.OpenApiFeature.Builder.html
404 /apidocs/io.helidon.security.integration.webserver/module-summary.html
404 /apidocs/io.helidon.security.providers.httpauth.ConfigUserStore/io/helidon/security/providers/httpauth/ConfigUserStore/ConfigUser.html
404 /apidocs/io.helidon.security.providers.httpsign.SignedHeadersConfig/io/helidon/security/providers/httpsign/SignedHeadersConfig/HeadersConfig.html
404 /apidocs/io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProviderBase/io/helidon/security/providers/idcs/mapper/IdcsRoleMapperProviderBase/Builder.html
404 /apidocs/io.helidon.security.providers.oidc.common/io/helidon/security/providers/oidc/common/BaseBuilder.html
404 /apidocs/io.helidon.webclient..api/io/helidon/webclient/api/ClientRequest.html
404 /apidocs/io.helidon.webclient/io/helidon/webclient/WebClient.Builder.html
404 /apidocs/io.helidon.webclient/io/helidon/webclient/WebClient.html
404 /apidocs/io.helidon.webserver.cors/io/helidon/cors/CrossOriginConfig.html
404 /apidocs/io.helidon.webserver.cors/io/helidon/cors/MappedCrossOriginConfig.html
404 /apidocs/io.helidon.webserver.cors/io/helidon/webserver/cors/CrossOriginConfig.html
404 /apidocs/io.helidon.webserver.http1/io/helidon/webserver/http1/Http1Config.html
404 /apidocs/io.helidon.webserver.servicecommon.HelidonFeatureSupport/io/helidon/webserver/servicecommon/HelidonFeatureSupport/Builder.html
404 /apidocs/io.helidon.webserver.servicecommon/io/helidon/webserver/servicecommon/RestServiceSettings.html
404 /apidocs/io.helidon.webserver/io/helidon/webserver/Handler.html
404 /apidocs/io.helidon.webserver/io/helidon/webserver/PathMatcher.html
404 /apidocs/io.helidon.webserver/io/helidon/webserver/ServerRequest.html
404 /apidocs/io.helidon.webserver/io/helidon/webserver/WebServer.Builder.html
404 https://docs.jboss.org/hibernate/orm/6.1.7.Final/javadocs/org/hibernate/jpamodelgen/JPAMetaModelEntityProcessor.html
404 https://docs.jboss.org/hibernate/orm/6.1.7.Final/userguide/html_single/Hibernate_User_Guide.html#BytecodeEnhancement
404 https://docs.jboss.org/hibernate/orm/6.1.7.Final/userguide/html_single/Hibernate_User_Guide.html#configurations
404 https://docs.jboss.org/hibernate/orm/6.1.7.Final/userguide/html_single/Hibernate_User_Guide.html#configurations-bytecode-enhancement
404 https://docs.jboss.org/hibernate/orm/6.1.7.Final/userguide/html_single/Hibernate_User_Guide.html#configurations-logging
404 https://docs.jboss.org/hibernate/orm/6.1.7.Final/userguide/html_single/Hibernate_User_Guide.html#tooling-maven
404 https://docs.jboss.org/hibernate/orm/6.1.7.Finaluserguide/html_single/Hibernate_User_Guide.html
404 https://docs.oracle.com/en/database/oracle/oracle-database/21/jjucpindex.html
 https://download.eclipse.org/microprofile/microprofile-config-3.0.3/microprofile-config-spec-3.0.3.html}
 https://download.eclipse.org/microprofile/microprofile-fault-tolerance-4.0.2/microprofile-fault-tolerance-spec-4.0.2.html}
404 https://download.eclipse.org/microprofile/microprofile-metrics-5.0.1/apidocs/org/eclipse/microprofile/metrics/package-info.html
404 https://download.eclipse.org/microprofile/microprofile-metrics-5.0/microprofile-metrics-spec-5.0.html#_incompatible_changes
404 https://download.eclipse.org/microprofile/microprofile-reactive-streams-operators-3.1.1/apidocs
404 https://download.eclipse.org/microprofile/microprofile-reactive-streams-operators-3.1.1/microprofile-reactive-streams-operators-spec-3.1.1.html
404 https://download.eclipse.org/microprofile/microprofile-reactive-streams-operators-3.1.1/microprofile-reactive-streams-operators-spec-3.1.1.html#_graphs
404 https://download.eclipse.org/microprofile/microprofile-reactive-streams-operators-3.1.1/microprofile-reactive-streams-operators-spec-3.1.1.html#_stages
404 https://github.com/GoogleContainerTools/jib/blob/v0.10.1-maven/jib-maven-plugin/docs/faq.md#why-is-my-image-created-48-years-ago
404 https://github.com/GoogleContainerTools/jib/blob/v0.10.1-maven/jib-maven-plugin/jib-maven-plugin/README.md#extended-usage
 https://github.com/oracle/helidon/tree/main}/examples/microprofile/bean-validation
 https://github.com/oracle/helidon/tree/main}/examples/microprofile/openapi
404 https://github.com/smallrye/jandex/maven-plugin
404 https://hibernate.org/orm/documentation/6.1.7.Final
404 https://jakarta.ee/specifications/bean-validation/3.0/bean-validation_3.0.html
 https://jakarta.ee/specifications/bean-validation/3.0/bean-validation_3.0.html}
404 https://jakarta.ee/specifications/cdi/4.0.1/jakarta-cdi-spec-4.0.1.html
404 https://jakarta.ee/specifications/cdi/4.0.1/jakarta-cdi-spec-4.0.1.html#implementation
404 https://jakarta.ee/specifications/cdi/4.0.1/jakarta-cdi-spec-4.0.1.html#spi
404 https://jakarta.ee/specifications/dependency-injection/2.0.1/apidocs/jakarta/inject/Singleton.html
404 https://jakarta.ee/specifications/dependency-injection/2.0.1/apidocs/jakarta/inject/inject
404 https://jakarta.ee/specifications/dependency-injection/2.0.1/apidocs/jakarta/inject/named
404 https://jakarta.ee/specifications/dependency-injection/2.0.1/jakarta-injection-spec-2.0.1.html
404 https://jakarta.ee/specifications/jsonp/2.1.1/apidocs
404 https://jakarta.ee/specifications/persistence/3.1.0/
404 https://jakarta.ee/specifications/persistence/3.1.0/apidocs/
404 https://jakarta.ee/specifications/persistence/3.1.0/apidocs/jakarta.persistence/jakarta/persistence/entity
404 https://jakarta.ee/specifications/persistence/3.1.0/apidocs/jakarta.persistence/jakarta/persistence/entitymanager
404 https://jakarta.ee/specifications/persistence/3.1.0/apidocs/jakarta.persistence/jakarta/persistence/package-summary.html
404 https://jakarta.ee/specifications/persistence/3.1.0/apidocs/jakarta.persistence/jakarta/persistence/persistencecontext
404 https://jakarta.ee/specifications/persistence/3.1.0/apidocs/jakarta.persistence/jakarta/persistence/spi/persistenceunitinfo
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#a12296
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#a12305
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#a12384
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#a18
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#a2999
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#a487
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#a6933
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#entities
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#list-of-managed-classes
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#mapped-superclasses
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#persistence-xml-file
404 https://jakarta.ee/specifications/persistence/3.1.0/jakarta-persistence-spec-3.1.0.html#persistence-xml-schema
404 https://jakarta.ee/specifications/restful-ws/3.1.0/apidocs
404 https://jakarta.ee/specifications/restful-ws/3.1.0/jakarta-restful-ws-spec-3.1.0.html
404 https://jakarta.ee/specifications/restful-ws/3.1.0/jakarta-restful-ws-spec-3.1.0.html#client_api
404 https://jakarta.ee/specifications/restful-ws/3.1.0/jakarta-restful-ws-spec-3.1.0.html#resource-classes
404 https://jakarta.ee/specifications/websocket/2.1.0/websocket-spec-2.1.0.html
404 https://micrometer.io/docs/concepts
 {https://github.com/oracle/helidon/tree/master/examples/security
502 {microprofile-rest-graphql-url}/apidocs

Steps to reproduce

cd docs
mvn clean package -Pjavadoc
mvn sitegen:serve
cd docs
# scrape all links
grep -E '(src|href)="' -r target/site/pages | \
	sed -E 's/.*(src|href="([^"]*)"){1}.*/\2/g' | \
	grep -v "localhost" | \
	grep -v "127.0.0.1" | \
	grep -v "example.org" | \
	grep -v "host:port" | \
	grep -v "your-host:your-port" | \
	sort | \
	uniq | \
	tee /tmp/urls.txt

# test each url
while read line ; do
  if [[ "${line}" =~ ^/ ]] ; then
    url="http://localhost:8080${line}"
  elif [[ "${line}" =~ ^\./ ]] ; then
    url="http://localhost:8080/${line:1}"
  else
    url="${line}"
  fi
  curl -w "%{http_code}" -s -o /dev/null "${url}" ; echo " ${line}"
done < /tmp/urls.txt | tee /tmp/urls-status.txt

# filter bad urls
grep -v -E "^(200|30[1-9])" /tmp/urls-status.txt
@romain-grecourt romain-grecourt added bug Something isn't working docs 4.x Version 4.x labels Dec 22, 2023
@romain-grecourt romain-grecourt added this to the 4.0.3 milestone Dec 22, 2023
@barchetta barchetta self-assigned this Dec 23, 2023
@barchetta barchetta mentioned this issue Jan 10, 2024
Merged
@barchetta
Copy link
Member

PR #8219 fixes the non-javadoc broken links. That leaves the following:

404 /apidocs/io.helidon.common.configurable/io.helidon.common.configurable/ScheduledThreadPoolSupplier.Builder.html#config(io.helidon.config.Config)
404 /apidocs/io.helidon.common.configurable/io.helidon.common.configurable/ThreadPoolSupplier.Builder.html#config(io.helidon.config.Config)
404 /apidocs/io.helidon.config/io/helidon/config/RetryPolicies.Builder.html
404 /apidocs/io.helidon.config/io/helidon/config/internal/FileConfigSource.FileBuilder.html
404 /apidocs/io.helidon.config/io/helidon/config/spi/AbstractConfigSourceBuilder.html
404 /apidocs/io.helidon.config/io/helidon/config/spi/AbstractParsableConfigSource.Builder.html#init-io.helidon.config.Config-
404 /apidocs/io.helidon.config/io/helidon/config/yaml/YamlConfigParser.html
404 /apidocs/io.helidon.config/io/helidon/configRetryPolicies.html#repeat-int-
404 /apidocs/io.helidon.integrations.openapi.ui/io/helidon/integrations/openapi/ui/OpenApiUi.Builder.html
404 /apidocs/io.helidon.metrics.api/Counter.html
404 /apidocs/io.helidon.metrics.api/DistributionSummary.html
404 /apidocs/io.helidon.metrics.api/Gauge.html
404 /apidocs/io.helidon.metrics.api/MeterRegistry.html
404 /apidocs/io.helidon.metrics.api/Timer.html
404 /apidocs/io.helidon.metrics.prometheus/PrometheusSupport.Builder.html
 /apidocs/io.helidon.microprofile.cors/io/helidon/microprofile/cors/CrossOrigin.html}
404 /apidocs/io.helidon.microprofile.metrics/RegistryFactory.html
404 /apidocs/io.helidon.openapi/OpenApiFeature.Builder.html
404 /apidocs/io.helidon.openapi/io.helidon.openapi.OpenApiFeature.Builder.html
404 /apidocs/io.helidon.security.integration.webserver/module-summary.html
404 /apidocs/io.helidon.security.providers.httpauth.ConfigUserStore/io/helidon/security/providers/httpauth/ConfigUserStore/ConfigUser.html
404 /apidocs/io.helidon.security.providers.httpsign.SignedHeadersConfig/io/helidon/security/providers/httpsign/SignedHeadersConfig/HeadersConfig.html
404 /apidocs/io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProviderBase/io/helidon/security/providers/idcs/mapper/IdcsRoleMapperProviderBase/Builder.html
404 /apidocs/io.helidon.security.providers.oidc.common/io/helidon/security/providers/oidc/common/BaseBuilder.html
404 /apidocs/io.helidon.webclient..api/io/helidon/webclient/api/ClientRequest.html
404 /apidocs/io.helidon.webclient/io/helidon/webclient/WebClient.Builder.html
404 /apidocs/io.helidon.webclient/io/helidon/webclient/WebClient.html
404 /apidocs/io.helidon.webserver.cors/io/helidon/cors/CrossOriginConfig.html
404 /apidocs/io.helidon.webserver.cors/io/helidon/cors/MappedCrossOriginConfig.html
404 /apidocs/io.helidon.webserver.cors/io/helidon/webserver/cors/CrossOriginConfig.html
404 /apidocs/io.helidon.webserver.http1/io/helidon/webserver/http1/Http1Config.html
404 /apidocs/io.helidon.webserver.servicecommon.HelidonFeatureSupport/io/helidon/webserver/servicecommon/HelidonFeatureSupport/Builder.html
404 /apidocs/io.helidon.webserver.servicecommon/io/helidon/webserver/servicecommon/RestServiceSettings.html
404 /apidocs/io.helidon.webserver/io/helidon/webserver/Handler.html
404 /apidocs/io.helidon.webserver/io/helidon/webserver/PathMatcher.html
404 /apidocs/io.helidon.webserver/io/helidon/webserver/ServerRequest.html
404 /apidocs/io.helidon.webserver/io/helidon/webserver/WebServer.Builder.html

@barchetta barchetta modified the milestones: 4.0.3, 4.0.4 Jan 11, 2024
@barchetta barchetta modified the milestones: 4.0.4, 4.1.0 Jan 18, 2024
@barchetta barchetta mentioned this issue Jan 26, 2024
Merged
@barchetta
Copy link
Member

PR #8300 fixes most of the javadoc links. The remaining broken links appear to be in the generated configuration attribution files:

-----
404 /apidocs/io.helidon.security.providers.httpauth.ConfigUserStore/io/helidon/security/providers/httpauth/ConfigUserStore/ConfigUser.html
src/main/asciidoc/config/io_helidon_security_providers_httpauth_ConfigUserStore_ConfigUser.adoc:30:Type: link:{javadoc-base-url}/io.helidon.security.providers.httpauth.ConfigUserStore/io/helidon/security/providers/httpauth/ConfigUserStore/ConfigUser.html[io.helidon.security.providers.httpauth.ConfigUserStore.ConfigUser]
-----
404 /apidocs/io.helidon.security.providers.httpsign.SignedHeadersConfig/io/helidon/security/providers/httpsign/SignedHeadersConfig/HeadersConfig.html
src/main/asciidoc/config/io_helidon_security_providers_httpsign_SignedHeadersConfig_HeadersConfig.adoc:30:Type: link:{javadoc-base-url}/io.helidon.security.providers.httpsign.SignedHeadersConfig/io/helidon/security/providers/httpsign/SignedHeadersConfig/HeadersConfig.html[io.helidon.security.providers.httpsign.SignedHeadersConfig.HeadersConfig]
-----
404 /apidocs/io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProviderBase/io/helidon/security/providers/idcs/mapper/IdcsRoleMapperProviderBase/Builder.html
src/main/asciidoc/config/io_helidon_security_providers_idcs_mapper_IdcsRoleMapperProviderBase_Builder.adoc:30:Type: link:{javadoc-base-url}/io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProviderBase/io/helidon/security/providers/idcs/mapper/IdcsRoleMapperProviderBase/Builder.html[io.helidon.security.providers.idcs.mapper.IdcsRoleMapperProviderBase.Builder]
-----
404 /apidocs/io.helidon.security.providers.oidc.common/io/helidon/security/providers/oidc/common/BaseBuilder.html
src/main/asciidoc/config/io_helidon_security_providers_oidc_common_BaseBuilder.adoc:30:Type: link:{javadoc-base-url}/io.helidon.security.providers.oidc.common/io/helidon/security/providers/oidc/common/BaseBuilder.html[io.helidon.security.providers.oidc.common.BaseBuilder]
-----
404 /apidocs/io.helidon.webserver.http1/io/helidon/webserver/http1/Http1Config.html
src/main/asciidoc/config/io_helidon_webserver_http1_Http1Config.adoc:30:Type: link:{javadoc-base-url}/io.helidon.webserver.http1/io/helidon/webserver/http1/Http1Config.html[io.helidon.webserver.http1.Http1Config]
-----
404 /apidocs/io.helidon.webserver.servicecommon.HelidonFeatureSupport/io/helidon/webserver/servicecommon/HelidonFeatureSupport/Builder.html
Fix broken links to javadocs
src/main/asciidoc/config/io_helidon_webserver_servicecommon_HelidonFeatureSupport_Builder.adoc:30:Type: link:{javadoc-base-url}/io.helidon.webserver.servicecommon.HelidonFeatureSupport/io/helidon/webserver/servicecommon/HelidonFeatureSupport/Builder.html[io.helidon.webserver.servicecommon.HelidonFeatureSupport.Builder]
-----
404 /apidocs/io.helidon.webserver.servicecommon/io/helidon/webserver/servicecommon/RestServiceSettings.html
src/main/asciidoc/config/io_helidon_webserver_servicecommon_RestServiceSettings.adoc:30:Type: link:{javadoc-base-url}/io.helidon.webserver.servicecommon/io/helidon/webserver/servicecommon/RestServiceSettings.html[io.helidon.webserver.servicecommon.RestServiceSettings]

@barchetta barchetta mentioned this issue Aug 1, 2024
Open
@barchetta
Copy link
Member

I have created issue #9088 to cover the broken javadoc links in the generated config references. All other broken links have been fixed, so closing this issue.

@m0mus m0mus added this to Backlog Aug 12, 2024
@m0mus m0mus moved this to Closed in Backlog Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@barchetta barchetta

Labels
4.x Version 4.x bug Something isn't working docs
Projects
Backlog
Archived in project
Milestone
4.1.0
Development

No branches or pull requests
2 participants
@romain-grecourt @barchetta