Mauricio Stekl created IGNITE-13157:
---------------------------------------

             Summary: Upgrade build process for Javadocs
                 Key: IGNITE-13157
                 URL: https://issues.apache.org/jira/browse/IGNITE-13157
             Project: Ignite
          Issue Type: Improvement
          Components: documentation
            Reporter: Mauricio Stekl
         Attachments: gsc_mobile_errors.png

I am reaching out to you all to see if you could help fix some issues with 
mobile usability in the Javadocs sections for Ignite website.
 
I know you might think most users will not read the API doc using their 
smartphones, and that is true. But as you can see in the attached screenshot 
gsc_mobile_errors.png, we have errors related to mobile usability reported by 
Google itself through GSC. Obviously this affects our performance on search 
results, as Google is giving more and more priority to mobile friendly websites.
For Apache Ignite website we basically have the largest part of the website 
with issues, since we only have around 30 pages mobile friendly, and 1000+ 
pages which are not. 
 
Specifically with Javadocs, the main problem is it contains old html frames for 
layout and navigation, among other markup bad practices, and this would make 
impossible to update any css to be responsive for small screens.  From what I 
was able to find [[1]|https://bugs.openjdk.java.net/browse/JDK-8215599] 
[[2]|https://bugs.openjdk.java.net/browse/JDK-8196202], starting with JDK 9 
there is a '--no-frames' option which fixes this problem. And with version 11 
this option is enabled by default and other features included. You can see here 
how the new layout looks: 
[https://docs.oracle.com/en/java/javase/11/docs/api/index.html]
 
Would it be possible to upgrade Java to version 11 only for building the 
javadocs? This might be a great starting point to fix these problems. Later we 
could update the .css to adjust font sizes and other details.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to