Skip to content

[WFGP-292] Generate documentation for Galleon packs #739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

[WFGP-292] Generate documentation for Galleon packs #739

wants to merge 5 commits into from

Conversation

jmesnil
Copy link
Member

@jmesnil jmesnil commented Jun 20, 2025

This fixes #738.

@jmesnil
[WFGP-292] Generate documentation for Galleon packs
e5c23ed 
This fixes wildfly#738.

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>
@github-actions github-actions bot added the stability-level/community "Community" stability level label Jun 20, 2025
jmesnil
jmesnil commented Jun 20, 2025
View reviewed changes
@jmesnil
update proposal to have a distinct goal to generate the documentation
57d9452 
Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>
@github-actions github-actions bot added stability-level/community "Community" stability level and removed stability-level/community "Community" stability level labels Jun 20, 2025
jamezp
jamezp reviewed Jun 20, 2025
View reviewed changes
spyrkob
spyrkob reviewed Jun 23, 2025
View reviewed changes
bstansberry
bstansberry reviewed Jun 26, 2025
View reviewed changes
bstansberry
bstansberry reviewed Jun 26, 2025
View reviewed changes
bstansberry
bstansberry reviewed Jun 26, 2025
View reviewed changes
yersan
yersan reviewed Jun 30, 2025
View reviewed changes
@github-actions github-actions bot added stability-level/community "Community" stability level and removed stability-level/community "Community" stability level labels Sep 17, 2025
@jmesnil jmesnil force-pushed the WFGP-292_doc_galleon-pack branch from 075a8cd to 0e69ef4 Compare September 17, 2025 14:23
@github-actions github-actions bot added stability-level/community "Community" stability level and removed stability-level/community "Community" stability level labels Sep 17, 2025
@jmesnil
Update proposal based on feedback
c29d0e9 
Added Yeray for outside perspective.

Signed-off-by: Jeff Mesnil <jmesnil@ibm.com>
@jmesnil jmesnil force-pushed the WFGP-292_doc_galleon-pack branch from 0e69ef4 to c29d0e9 Compare September 17, 2025 14:33
@github-actions github-actions bot added stability-level/community "Community" stability level and removed stability-level/community "Community" stability level labels Sep 17, 2025
bstansberry
bstansberry reviewed Sep 17, 2025
View reviewed changes
bstansberry
bstansberry reviewed Sep 17, 2025
View reviewed changes
bstansberry
bstansberry reviewed Sep 17, 2025
View reviewed changes
provisioning/WFGP-292_doc_galleon-pack.adoc Outdated
== Overview

At its core, WildFly is composed of extensions that provide management resources (grouped in subsystems and deployment resources).
WildFly is providing a model reference for these resources at https://docs.wildfly.org/36/wildscribe/.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WDYT about starting to call this "management API reference" not "model reference"?

We've used the term "model" around this general area for years but I couldn't tell you precisely what we mean by it. And I suspect a user has no clue.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a section in the overview to clarify the terms used in the proposal, Management API, Management API Reference & Management Model (for consistency, the model.json file is renamed to management-api.json)
Please tell me if that's clearer?

bstansberry
bstansberry reviewed Sep 17, 2025
View reviewed changes
bstansberry
bstansberry reviewed Sep 17, 2025
View reviewed changes
bstansberry
bstansberry reviewed Sep 17, 2025
View reviewed changes
@github-actions github-actions bot added stability-level/community "Community" stability level and removed stability-level/community "Community" stability level labels Sep 18, 2025
@jmesnil
Update after brian's feedback
01da404 
* describes the terms Management API, Management API Reference & Management Model
* rename model.json to management-api.json

Signed-off-by: Jeff Mesnil <jmesnil@ibm.com>
@jmesnil jmesnil force-pushed the WFGP-292_doc_galleon-pack branch from 7597b27 to 01da404 Compare September 18, 2025 07:40
@github-actions github-actions bot added stability-level/community "Community" stability level and removed stability-level/community "Community" stability level labels Sep 18, 2025
@jmesnil
minor update
f31e433 
Signed-off-by: Jeff Mesnil <jmesnil@ibm.com>
@github-actions github-actions bot added stability-level/community "Community" stability level and removed stability-level/community "Community" stability level labels Sep 30, 2025
@jmesnil
Copy link
Member Author

jmesnil commented Sep 30, 2025

Feature development is done.

I've opened a PR against @jfdenise branch that provides the generated documentation for the feature pack.
I have a branch of WildFly that uses a snapshot of the galleon-plugins to generate the doc (instead of wildscribe): https://github.com/jmesnil/wildfly/tree/feature-pack-documentation.

The output of the doc can be seen at https://jmesnil.github.io/wildfly.github.io/38/feature-pack/doc/index.html.
When we have a release of the galleon-plugins that contains the feature, I will finish to polish WildFly documentation. For example, the Foundational Galleon layers & Basic Galleon Layers would be replaced/augmented by a link to https://jmesnil.github.io/wildfly.github.io/38/feature-pack/doc/index.html#layers

More interestingly, I also updated the GRPC feature pack to generate its documentation (that does not exist at the moment):

https://jmesnil.github.io/wildfly-grpc-feature-pack/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bstansberry bstansberry bstansberry left review comments

@jamezp jamezp jamezp left review comments

@yersan yersan yersan left review comments

+1 more reviewer

@spyrkob spyrkob spyrkob left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
stability-level/community "Community" stability level
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Generate documentation for feature packs
5 participants
@jmesnil @bstansberry @jamezp @spyrkob @yersan