-
Notifications
You must be signed in to change notification settings - Fork 22
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.
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
Update docs home page #84
base: main
Are you sure you want to change the base?
Conversation
and move previous releases to an archives page Signed-off-by: Jeff Mesnil <[email protected]>
@yersan @bstansberry Thanks for the review, I've amended the PR with your suggestions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I have no more comments then
|
||
|link:galleon-plugins[WildFly Galleon Plug-ins] | ||
WildFly Glow is a tool and a Maven plugin to automatically discover an application's requirements and provision WildFly with the right set of capabilities. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't want to block merging on this as I think it looks really nice and much cleaner than what we have now.
The only thing I wan to know is GLOW isn't really a Maven Plugin. The wildfly-maven-plugin uses GLOW and there is a Maven Plugin for integrating with Arquillian. That said, I don't really have better wording for it :)
|link:prospero[Prospero] | ||
|
||
|=== | ||
Learn more about link:bootablejar[Bootable Jar]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not a comment about this PR. I wonder if we should see how we could integrate the bootable JAR documentation into the wildfly-maven-plugin. I'm not sure how that would look, but it's good documentation and I don't think we want to lose it once he wildfly-jar-maven-plugin
goes away.
@@ -1,178 +1,101 @@ | |||
= WildFly Documentation | |||
:toc: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is somewhat of a personal preference, but I think :toc: left
looks a bit better on desktop/laptop screens. It will render on top for smaller mobile devices.
and move previous releases to an archives page
An example of the generated pages is at https://jmesnil.github.io/wildfly.github.io/
The current design list all projects without giving any hints about what the project actually does.
The new design adds a 1-sentence description of the project and group them in buckets ("Build app", "Provision WildFLy", "Cloud").
I'm also using 2 asciidoc attributes
wildfly-latest-version
andwildfly-latest-major
to simplify the maintenance of the page.One thing I change for WildFly 35 was adding a link to Jakarta EE 11 (in addition to EE 10) platform API
I also moved the links to previous doc releases to an archive page (that needs to be generated).
If that PR is merged, I'll also update https://github.com/wildfly/wildfly/blob/main/docs/README.adoc#edit-and-build-index to take into account the changes.