Hi,
Here is an update on that proposal[1] after your feedback (thanks!).
I’ve a prototype of the RFE[2] that is good enough to give a broad idea of the finished feature.
It is using a new documentation generator that supersedes WildScribe and use Qute for its template engine.
The impact for feature pack developers is minimal, they will have to bump the galleon-plugins version and that’s it.
To make it more visual, I applied the changes to WildFly itself and the diff is minimal[3] (including the changes to the doc module of WildFly & the removal of the Wildscribe dependency). WildFly is a special case as we want to have a single documentation entry
point while we have 2 feature packs (wildfly-galleon-pack & wildfly-ee-galleon-pack). For this special case, we generates the documentation from the feature pack *and its dependencies*. For other feature packs, there will be nothing to do.
I generated this doc and pushes it to my fork of docs.wildfly.org at
https://urldefense.proofpoint.com/v2/url?u=https-3A__jmesnil.github.io_wildfly.github.io_37_feature-2Dpack_doc_reference_&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=3WX048MDIXKJC-j_eVezIIV5qxIqJjb2fzbXsdbVjjE&e=
[4]
For reference, the existing doc is at https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.wildfly.org_37_wildscribe_index.html&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=UA-ns6jJqrx2xlo37Ojnwf4lphlh-dpzPud7-XY0w0s&e=
It’s not feature complete (log codes and capabilities are missing) but it’s good enough to give you an idea.
In particular, it shows the following improvements:
* All subsystems are described (eg microprofile-reactive-messaging-smallrye is missing in the current doc)
* Each attribute and operations can display their raw DMR model in addition to the elements presented in the UI (that proves useful for complex attributes or operations).
* There is some information that is not displayed by wildscribe (eg “alternatives") that is visible in the raw DMR model if we don’t want to surface it to the UI...
* Current: https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.wildfly.org_37_wildscribe_subsystem_messaging-2Dactivemq_connection-2Dfactory_index.html-23attr-2Dconnectors&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=Mf8f2leYwQWHq1e_V_II3R5hIMij45svXf3t-VMM-kg&e=
* New https://urldefense.proofpoint.com/v2/url?u=https-3A__jmesnil.github.io_wildfly.github.io_37_feature-2Dpack_doc_reference_subsystem_messaging-2Dactivemq_connection-2Dfactory_index.html-23connectors&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=xq6_eueAACkTfCEi26xZNb0EBFAmrhJhV-SO_LBIWZ8&e=
* most importantly, this doc comes for free for any feature pack (cloud, datasources, grpc, ai, etc.)
As a part of this RFE, I also want to generate doc about the feature pack itself:
https://urldefense.proofpoint.com/v2/url?u=https-3A__jmesnil.github.io_wildfly.github.io_37_feature-2Dpack_doc_index.html&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=pR9tRFZGk8N0CnJqtW7vEK88kWhTQXgN00iH8s2UODA&e=
This offers interesting information such as:
* the maven dependency to provision the feature pack
* general information (description, licenses, source control)
* layer information (including their dependencies, packages & properties)
* that would complement or replace our handcrafted doc at https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.wildfly.org_37_Galleon-5FGuide.html-23wildfly-5Flayers&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=Dm8YuapZ_kHz1Jn7En8vJkqcSy2TIm_mWIP4cgyuqWk&e=
& https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.wildfly.org_wildfly-2Dgalleon-2Dfeature-2Dpacks_-23-5Fsupport-5Ffor-5Fwildfly-5F37-5F0-5F1-5Ffinal&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=iHyO9wukUj2tA8t1cNcB4aSUKi39wMgJU-fK0FZpaHQ&e=
The feature pack doc needs a bit more polish but the generation of the model reference should soon be good enough to be usable.
This would be part of a major bump of our Galleon plugins (there is plenty of major features coming up in them).
I’ll finish the model reference to be on par (and above) with wildscribe.
Please have a look at the output at [1] and provide any feedback to the proposal at [4].
Thanks,
Jeff
[1] https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_jmesnil_wildfly-2Dproposals_blob_WFGP-2D292-5Fdoc-5Fgalleon-2Dpack_provisioning_WFGP-2D292-5Fdoc-5Fgalleon-2Dpack.adoc&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=OIyqOjIFD66LeX--Ox8heJj-GE60pHiHIk7K5LQUGQ8&e=
[2] https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_jmesnil_galleon-2Dplugins_tree_fp-2Dmetadata&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=IhSdv3AJFNLUXicVm35UllAO9WC0EEZC0jxS0t0AWWM&e=
[3] https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_wildfly_wildfly_compare_main...jmesnil-3Awildfly-3Afeature-2Dpack-2Ddocumentation&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=Rlrfe7XblxFRChHHYOitQSxvjRjllUjSrp2BWCemmhs&e=
[4] https://urldefense.proofpoint.com/v2/url?u=https-3A__jmesnil.github.io_wildfly.github.io_37_feature-2Dpack_doc_reference_&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=3WX048MDIXKJC-j_eVezIIV5qxIqJjb2fzbXsdbVjjE&e=
On 20 Jun 2025, at 15:57, Jeff Mesnil <jmesnil@redhat.com> wrote:
Thanks Yeray,
We have a feature team so we can proceed with the planning phase and review the proposal: https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_wildfly_wildfly-2Dproposals_pull_739&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=O1YWtN2CeWyi4jWBLQvyCqKAAV_e70hH7byUNavaMZY&e=
Cheers,
Jeff
On 20 Jun 2025, at 12:43, Yeray Borges Santana <yborgess@redhat.com> wrote:
Hello,
I can play the outsider perspective role for this RFE, Jeff, so count on me for this task.
Regards
On Fri, Jun 20, 2025 at 10:13 AM Jeff Mesnil via wildfly-dev <wildfly-dev@lists.jboss.org> wrote:
Hi,
I’ve created a proposal[1] to generate a documentation archive when a feature pack is created (similar to the javadoc archive that is generated when a Java jar is built by Maven)
I’m looking for a feature team to work on this proposal.
Jean-Francois and Emmanuel already provided some PoC around this idea so I nominated you as SMEs :)
But I’d need another outside perspective to fully form the team.
This RFE does not impact the runtime so stability level is not directly applicable but I aim to do something equivalent to the quality expected by the “community” stability level.
Best regards,
Jeff
[1] https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_wildfly_wildfly-2Dproposals_pull_739&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=O1YWtN2CeWyi4jWBLQvyCqKAAV_e70hH7byUNavaMZY&e=
--
Jeff Mesnil
Engineer @ Red Hat
https://urldefense.proofpoint.com/v2/url?u=http-3A__jmesnil.net_&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=mpmBtqrCkDKwAEAWfymGExqspXJympNU3mBqMb5-5K4&e=
_______________________________________________
wildfly-dev mailing list -- wildfly-dev@lists.jboss.org
To unsubscribe send an email to wildfly-dev-leave@lists.jboss.org
Privacy Statement: https://urldefense.proofpoint.com/v2/url?u=https-3A__www.redhat.com_en_about_privacy-2Dpolicy&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=KpjSz8loAOPFsV4ToIbUea8XfseAZjKRum5Td7Uxwhs&e=
List Archives: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.jboss.org_archives_list_wildfly-2Ddev-40lists.jboss.org_message_37SBXCL2H3RU2M74NOEZC7DJJAIULKWP_&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=3rE74p7eVfLwVG8vWH0QX-Kpe6Id2WFQp1GQaS24IyA&e=
--
Jeff Mesnil
Engineer @ Red Hat
https://urldefense.proofpoint.com/v2/url?u=http-3A__jmesnil.net_&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=mpmBtqrCkDKwAEAWfymGExqspXJympNU3mBqMb5-5K4&e=
--
Jeff Mesnil
Engineer @ Red Hat
https://urldefense.proofpoint.com/v2/url?u=http-3A__jmesnil.net_&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=mpmBtqrCkDKwAEAWfymGExqspXJympNU3mBqMb5-5K4&e=
_______________________________________________
wildfly-dev mailing list -- wildfly-dev@lists.jboss.org
To unsubscribe send an email to wildfly-dev-leave@lists.jboss.org
Privacy Statement: https://urldefense.proofpoint.com/v2/url?u=https-3A__www.redhat.com_en_about_privacy-2Dpolicy&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=KpjSz8loAOPFsV4ToIbUea8XfseAZjKRum5Td7Uxwhs&e=
List Archives: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.jboss.org_archives_list_wildfly-2Ddev-40lists.jboss.org_message_EEX4TV4SO2E762COICVMFP7MWF22AK66_&d=DwIGaQ&c=BSDicqBQBDjDI9RkVyTcHQ&r=hY9ssjZOzTr6nBT17SjZxQ&m=OaT6x1U3fgJczrZBtvd3F8C8Xk-9LpmH3jLfhzc4GHXwosO96H315B5knhPGBh07&s=kp4Jy8M1_I0sG9xMvzjyxMEt2Dt80kx-zDtrHXwkirc&e=