6:12 a.m.
Hi,
There are been some progress on the consolidation of WildFly documentation
In
https://github.com/wildfly/wildfly.github.io/issues/62, we have expanded the list of
projects related to WildFly that could benefit from publishing their
content/documentation.
In particular, Brian suggested to look at https://github.com/wildfly/wildfly-proposals
that is the central location for analysis and design documents of new features and
capabilities in the WildFly project universe.
# Publish wildfly-proposals documentation
There is a *lot* of very good content in that repository but this is not easy to find it.
I have opened a PR to publish all our proposals (which are asciidoc documents) as a web
site.
The PR is at https://github.com/wildfly/wildfly-proposals/pull/538 and you can preview the
result at
https://jmesnil.github.io/wildfly-proposals/
(when merged, the actual URL will be docs.wildfly.org/wildfly-proposals
<http://docs.wildfly.org/wildfly-proposals>)
The home page lists all the categories and their proposals (a proposal can belong to one
or many categories).
The proposals are currently lightly categorised using the system layout.
However, the proposals very often touches multiple categories.
This web site allows to see the full breadth of our proposals.
For example if you were browsing the « wf-galleon » on the GitHub repo
https://github.com/wildfly/wildfly-proposals/tree/main/wf-galleon you would not notice a
lot of activity around Galleon layers and feature packs.
If you now browse the web site and all proposals that were flagged with `wf-galleon`,
there is a lot more: https://jmesnil.github.io/wildfly-proposals/#wf-galleon
# Changes to WildFly release process
In terms of changes to our existing proposal template, there is not many:
1. Add a YAML front matter with your categories. If you want to add a new category, edit
the _data/wildfly-categories.yaml
2. For consistency, do not put tracking issues in the title (WFLY-XXX, EAP7-YYY)
The proposed template is up to date with these changes.
If we merge this PR to publish the doc, we would have to update opened PRs before they are
merged. I did it for the 343 merged proposals and it’s very lightweight (as you can see
from a single change at
https://github.com/wildfly/wildfly-proposals/pull/538/files#diff-54ea8f7b...)
We can also curate our categories and revisit some of our proposals to expand their
categories in future steps.
However having now all this technical content published on wildfly.org
<http://wildfly.org/> would be very useful to WildFly users and developers.
Best regards,
Jeff
--
Jeff Mesnil
Engineer @ Red Hat JBoss EAP
http://jmesnil.net/