[
https://issues.apache.org/jira/browse/SLING-10016?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Konrad Windszus updated SLING-10016:
------------------------------------
Description:
In the README the following statements need some clarification
(https://github.com/apache/sling-org-apache-sling-servlets-resolver/blob/master/README.md#so-how-do-i-deploy-my-scripts):
bq. create a src/main/resources/javax.script folder in your bundle (if you want
to embed the scripts as they are) or just put the scripts in src/main/scripts
if you want to precompiled them (e.g. JSP and HTL);
It should be clarified, which scripts need to be embedded (instead of
precompiled) (compare with SLING-10012)
bq. inside each resourceType folder you can optionally create a Version folder;
this has to follow the Semantic Versioning constraints described at [1];
IMHO there is no logic derived from a version part in the resource type,
therefore one can just as well use versions like v1 and also the version folder
does not necessarily have to be leaf folder!
E.g. Core WCM components use a resource type like {{myResource/v1/myResource}}
(https://github.com/adobe/aem-core-wcm-components/discussions/1327)
Update: It seems that when the leaf folder path is a version string there is
indeed some logic which resolves resources with type {{myType}} to servlet
{{myType/<newestVersion>}}. That is worth to mention explicitly and also it is
not clear if both {{myType}} and {{myType/<newestVersion>}} exist, which one
takes precedence!
Also it would be nice to move the information from the README directly to
https://sling.apache.org/documentation/the-sling-engine/servlets.html#bundled-scripts-1.
was:
In the README the following statements need some clarification
(https://github.com/apache/sling-org-apache-sling-servlets-resolver/blob/master/README.md#so-how-do-i-deploy-my-scripts):
bq. create a src/main/resources/javax.script folder in your bundle (if you want
to embed the scripts as they are) or just put the scripts in src/main/scripts
if you want to precompiled them (e.g. JSP and HTL);
It should be clarified, which scripts need to be embedded (instead of
precompiled) (compare with SLING-10012)
bq. inside each resourceType folder you can optionally create a Version folder;
this has to follow the Semantic Versioning constraints described at [1];
IMHO there is no logic derived from a version part in the resource type,
therefore one can just as well use versions like v1 and also the version folder
does not necessarily have to be leaf folder!
E.g. Core WCM components use a resource type like {{myResource/v1/myResource}}
(https://github.com/adobe/aem-core-wcm-components/discussions/1327)
Update: It seems that when the leaf folder path is a version string there is
indeed some logic which maps resource with type {{myType}} to
{{myType/<newestVersion>}}. That is worth to mention explicitly and also it is
not clear if both {{myType}} and {{myType/<newestVersion>}} exist, which one
takes precedence!
Also it would be nice to move the information from the README directly to
https://sling.apache.org/documentation/the-sling-engine/servlets.html#bundled-scripts-1.
> Clarify bundled script layout
> -----------------------------
>
> Key: SLING-10016
> URL: https://issues.apache.org/jira/browse/SLING-10016
> Project: Sling
> Issue Type: Improvement
> Components: Servlets
> Affects Versions: Servlets Resolver 2.7.12
> Reporter: Konrad Windszus
> Priority: Major
>
> In the README the following statements need some clarification
> (https://github.com/apache/sling-org-apache-sling-servlets-resolver/blob/master/README.md#so-how-do-i-deploy-my-scripts):
> bq. create a src/main/resources/javax.script folder in your bundle (if you
> want to embed the scripts as they are) or just put the scripts in
> src/main/scripts if you want to precompiled them (e.g. JSP and HTL);
> It should be clarified, which scripts need to be embedded (instead of
> precompiled) (compare with SLING-10012)
> bq. inside each resourceType folder you can optionally create a Version
> folder; this has to follow the Semantic Versioning constraints described at
> [1];
> IMHO there is no logic derived from a version part in the resource type,
> therefore one can just as well use versions like v1 and also the version
> folder does not necessarily have to be leaf folder!
> E.g. Core WCM components use a resource type like
> {{myResource/v1/myResource}}
> (https://github.com/adobe/aem-core-wcm-components/discussions/1327)
> Update: It seems that when the leaf folder path is a version string there is
> indeed some logic which resolves resources with type {{myType}} to servlet
> {{myType/<newestVersion>}}. That is worth to mention explicitly and also it
> is not clear if both {{myType}} and {{myType/<newestVersion>}} exist, which
> one takes precedence!
> Also it would be nice to move the information from the README directly to
> https://sling.apache.org/documentation/the-sling-engine/servlets.html#bundled-scripts-1.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
