[JSMODELS-29] DEV-DOC: Update JavaScript Models module page for GraalVM Created: 24/Mar/22  Updated: 22/Feb/23

Status: Selected
Project: Magnolia Javascript Models
Component/s: None
Affects Version/s: 2.0
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Martin Drápela Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Cloners
is cloned by JSMODELS-30 DEV-DOC: Update How to work with Java... Selected
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Date of First Response:
Epic Link: Support

 Description   

Current status

module page (v1.2) is Nashorn-only: 

/Modules/List-of-modules/JavaScript-Models-module.adoc

(https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/product-docs/browse/modules/ROOT/pages/Modules/List-of-modules/JavaScript-Models-module.adoc)

Tasks

  1. Rename the h2 "Java, JavaScript and Nashorn" to "Java, JavaScript, Nashorn and GraalVM"; move there the note about the deprecation of the Nashorn.
  2. Add two new h2 (==) subs, titled (and increase the levels of the headers existing below accordingly):
    • GraalVM implementation
    • Nashorn implementation (deprecated)
  3. Move the current Nashorn content under the new Nashorn section.
  1. Copy the content also to the GraalVM, but update this section for GraalVM (v2.0).

Release target / content storage

According to this page, https://documentation.magnolia-cms.com/display/PMTEAM/Core+Releases+Scope+and+Plan , the GraalVm impl should go out with mgnl 6.3, so I'd suggest we keep the changes on a separate docu branch (called JSMODELS-24-doc-v2-graalvm maybe), including the content of the updated How to work with JavaScript models (a subtask).



 Comments   
Comment by Scot Rhodes [ 27/Jun/22 ]

Hi all,

I have created some documentation in the "docs" folder under the branch JSMODELS-24. Perhaps we can use these, once completed, to update the Modules documentation page? I'm following the existing https://docs.magnolia-cms.com/product-docs/6.2/Modules/List-of-modules/JavaScript-Models-module.html page as a template for these docs.

Sincerely,

Scot

Comment by Scot Rhodes [ 27/Jun/22 ]

Hi all,

I've got some initial docs ready for review. Unfortunately, Git isn't able to read the local references too well, but if you have the ASCII docs plugin installed with IntelliJ, it's readable. I could merge these into a single doc like it is in the product-docs if that makes your life easier.

https://git.magnolia-cms.com/projects/MODULES/repos/javascript-models/browse/docs?at=JSMODELS-24

Sincerely,

Scot

Comment by Scot Rhodes [ 27/Jun/22 ]

Created a new branch dedicated to the docs, and PR just submitted: https://git.magnolia-cms.com/projects/MODULES/repos/javascript-models/browse?at=refs%2Fheads%2FJSMODELS-29 

Generated at Mon Feb 12 05:58:56 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.