jakartaee / jakartaee-documentation-ui Goto Github PK

Currently, if you access the root of the jakarta-tutorial path, you get an error. We'd like it to forward you to /current/index.html.

To be more precise:

Currently:

• https://jakartaee.github.io/jakartaee-documentation/jakartaee-tutorial/9.1/ displays Jakarta EE 9.1 tutorial
• https://jakartaee.github.io/jakartaee-documentation/jakartaee-tutorial/current/ displays Jakarta EE 10 turorial
• https://jakartaee.github.io/jakartaee-documentation/jakartaee-tutorial/ yields a 404, but we want it to redirect to https://jakartaee.github.io/jakartaee-documentation/jakartaee-tutorial/current/

This is happening because the repo name has changed. We may need a new access token too, which may require help from the Eclipse folks since we don't have admin access to the jakartaee-documentation repo.

See: https://github.com/jakartaee/jakartaee-documentation-ui/actions/runs/6884168298/job/18726143603

This should be easy for someone who has worked with Github Actions or Bitbucket Pipelines or something similar.

Currently, the documentation has no favicon (the icon displayed in the tab header). It should have one that matches the one on the main Jakarta EE site.

The favicon can be found here: https://github.com/jakartaee/jakarta.ee/blob/src/static/images/jakarta/favicon.ico.
You can add it to the UI by following these steps: https://docs.antora.org/antora-ui-default/add-static-files/

I noticed that there are a small number of third party dependencies that may require due diligence review by the IP Team.

AFAICT, most of them declare themselves as MIT, but there is at least one in the list for which we can't find license information. The Eclipse Dash License Tool has flagged them as requiring further investigation.

$ java -jar {dash-path}/org.eclipse.dash.licenses-{version}.jar package-lock.json
[main] INFO License information could not be automatically verified for the following content:
[main] INFO 
[main] INFO npm/npmjs/-/body/5.1.0
[main] INFO npm/npmjs/-/console-stream/0.1.1
[main] INFO npm/npmjs/-/continuable-cache/0.3.1
[main] INFO npm/npmjs/-/jsonify/0.0.1
[main] INFO npm/npmjs/-/path-platform/0.11.15
[main] INFO npm/npmjs/-/safe-json-parse/1.0.1
[main] INFO npm/npmjs/@fontsource/open-sans/4.5.14
[main] INFO npm/npmjs/@fontsource/roboto-mono/4.5.8
[main] INFO 
[main] INFO This content is either not correctly mapped by the system, or requires review.

AFAICT, most of the libraries in the list declare themselves as MIT, but there is at least one in the list for which we can't find license information. The Eclipse Dash License Tool has flagged them as requiring further investigation.

I ran the tool against the package-lock.json file with an assumption that it is up-to-date.

The Dash License Tool has an option to automatically create review request records to engage IP Team and resolve the outstanding licence information.

Please engage in the IP Due Diligence process.

fyi @ivargrimstad @mtdelgadoa

Hello,

1. when I want to search within the Tutorial (https://jakartaee.github.io/jakartaee-documentation/jakartaee-tutorial/9.1/) I write a phrase in the field with the placeholder "Search the docs" and have the results that correspond to every word in the phrase.

I tried to include my phase in a double quotes (as in google) but the result is the same.

2. But if you go to "Antora" site (https://docs.antora.org/antora/latest/) and try to search a whole phrase including it in the double quotes, it works well.

Thank you,
Dmitri.