Feature Request - SEO and UX Improvements #137
Description
Now that we are getting more search visibility, @shabnammayel and I were discussing a few changes that might help improve ranking and usability.
1. Update the page title tags + meta description tags
For example: https://jakarta.ee/learn/docs/jakartaee-tutorial/current/web/faces-page-core/faces-page-core.html
This page title tag is: Using Converters, Listeners, and Validators :: Jakarta EE Tutorial :: Jakarta EE Documentation
Could we update the template to include the spec, “Jakarta Faces” in the title tag?
The template could be Specification :: Page title :: Jakarta EE Tutorial
Would it be possible to add the Jakarta EE Version?
For the meta description tag, can we add a templated one that just takes the first 160 chars of the main content for the page?
2. Add a label to the Jakarta version switcher
There are two spots on the page where you can change the Jakarta EE Version. At the top of the page can we add a label “Jakarta EE Version” before the number? At the bottom of the page can we change “Jakarta EE Tutorial” to “Jakarta EE Tutorial Version”?
3. Update the messaging around the tutorial being out of date
The Jakarta EE 10 tutorial has pages with messaging such as “We are working on a fresh, updated Jakarta EE Tutorial. This section hasn’t yet been updated.” The Preface says “This section is currently a draft, and is subject to change.”
Jakarta EE 11 has been released and since these pages have not been updated, we should replace these messages with a more generic message like “Last updated for Jakarta EE Version 9.1” - I'm not sure how many changes need to be made for 10 or if some of these notices can be removed altogether. Are they there because something needs to be added to explain changes in Jakarta EE 10?
Would love to heard your thoughts @ivargrimstad and @TanjaObradovic
I am concerned that our current messaging is signalling to google that these pages aren’t relevant.