search

jakartaee / specifications

Documentation base for Specification pages be published at jakarta.ee via Hugo and git submodules
Eclipse Public License 2.0
118 stars 79 forks source link

Broken Links #520

Open excentrickristy opened 2 years ago

excentrickristy commented 2 years ago

Hello, I've been working with Shabnam on technical SEO cleanup and found the following issues.

On this page: https://jakarta.ee/specifications/bean-validation/3.0/jakarta-bean-validation-spec-3.0.html

The "a" tag should be removed from these two URLs because they are registering as broken links image

On this page: https://jakarta.ee/specifications/enterprise-beans/4.0/jakarta-enterprise-beans-spec-core-4.0.html

There are a number of links in the content that are meant to serve as page anchors but the URL of the page must have changed at some point. You can see highlighted here at example. image

On this page, there needs to be a search and replace to that any anchor tags written with this href: ./enterprise-beans-spec-opt-4.0.html

are replaced with: ./jakarta-enterprise-beans-spec-opt-4.0.html

There are also references on this page to Ejb.html which much have been a previous name for this document - they need to be replaced: image

They should be replaced with this as well to fix these broken links: ./jakarta-enterprise-beans-spec-opt-4.0.html

On these pages: https://jakarta.ee/specifications/cdi/4.0/apidocs/overview-tree.html https://jakarta.ee/specifications/cdi/4.0/apidocs/allclasses-index.html https://jakarta.ee/specifications/cdi/4.0/apidocs/allclasses.html https://jakarta.ee/specifications/cdi/4.0/apidocs/index-all.html https://jakarta.ee/specifications/cdi/4.0/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/class-use/buildservices https://jakarta.ee/specifications/cdi/4.0/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-summary.html https://jakarta.ee/specifications/cdi/4.0/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/package-tree.html

The BuildServicesResolver link is broken

Links to: https://jakarta.ee/specifications/cdi/4.0/apidocs/jakarta.cdi/jakarta/enterprise/inject/build/compatible/spi/BuildServicesResolver.html

Not sure what the correct link is though.

On this page: https://jakarta.ee/specifications/faces/3.0/apidocs/com/sun/faces/application/resource/resourcehandlerimpl

There are multiple broken links to the overview summary: https://jakarta.ee/specifications/faces/3.0/apidocs/com/sun/overview-summary.html

Not sure what the correct link is though.

chrisguindon commented 1 year ago

@ivargrimstad How can we ensure that these issues are being assigned and dealt with by our spec projects?

@excentrickristy Created a few similar issues in the last 6 months but they haven't been dealt with:

Thanks!

ivargrimstad commented 1 year ago

@chrisguindon They will have to be brought to the attention of the spec project producing the artifacts. As these are normative artifacts produced by these projects for a release, they cannot be changed without releasing at least a service release of the specification. This is not something we have done historically, so the best approach would be to fix it in the next release of the specification.

chrisguindon commented 1 year ago

@chrisguindon Do you need anything from me or @excentrickristy to ensure that this is brought to the attention of the spec project or can we leave it to you to ensure that this gets done?

ivargrimstad commented 1 year ago

I'll see what I can do. Don't expect this to be prioritized, though. It is hard enough to get releases out for new specs, so I wouldn't be too optimistic about getting out a service release of an old spec to fix a couple of links... For the future, it would be great if @excentrickristy could create the issue directly in the affected spec project's issue tracker.

chrisguindon commented 1 year ago

For the future, it would be great if @excentrickristy could create the issue directly in the affected spec project's issue track

She's looking at this from a website perspective. What's the best way for her to find the right repo?

For example, for https://jakarta.ee/specifications/cdi/* is it simply a question of searching for "cdi" via the github search for the jakarta.ee organization?

https://github.com/jakartaee?q=cdi&type=all&language=&sort=

I see 2 repos in the results. Which one is the right one?

ivargrimstad commented 1 year ago

You're right, it is probably a bit tricky to find the right one. It can also be in the EE4J github organization, which isn't even called EE4J, but eclipse-ee4j to make it more interesting :)

Creating one issue per spec (in your example "cdi") here is a step in the right direction. Then someone from the spec committee can move or copy the issue over to the correct repository. Collecting multiple findings in one issue across multiple specs makes it harder to follow up.