Skip to content
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

[WFLY-18428] Improve the 'Get Started' Experience with WildFly #536

Merged
merged 1 commit into from
May 22, 2024

Conversation

jmesnil
Copy link
Member

@jmesnil jmesnil commented Sep 11, 2023

Proposal to improve the get started experience with WildFly, its related resources and changes to the wildfly.org web site to promote a fresh modern way to develop Entreprise Java applications with WildFly.

JIRA: https://issues.redhat.com/browse/WFLY-18428

@jmesnil
Copy link
Member Author

jmesnil commented Sep 11, 2023

A proof of concept of this proposal is live at http://jmesnil.github.io/wildfly.org/getstarted/.

It depends on @darranl's archetype that is not released yet. You can however install it locally with:

git clone https://github.com/jmesnil/wildfly-archetypes.git --branch darranl-WFLY-17651 && cd wildfly-archetypes && mvn install

then, you can follow the steps at http://jmesnil.github.io/wildfly.org/getstarted/

@jmesnil jmesnil force-pushed the WFLY-18428_get_started_with_wildfly branch from 8163ff4 to 32e9809 Compare September 11, 2023 10:08
* WildFly provisioning and configuration is controlled by the `wildfly-maven-plugin`
** We want to promote a modern way (sustainable, maintainable) to develop with WildFly. Any interaction with WildFly is controlled by the wildfly-maven-plugin. This implies that instructions to download WildFly server with zips or modifyings its XML configuration by hand are prohibited
* Dependencies to Jakarta EE artifacts are controlled by the WildFly BOM for Jakarta EE
* Integration tests are configured to use Arquillian against the WildFly server provisioned by the `wildfly-maven-plugin`
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to cover the proposed plan for adding guides too so we don't lose track of that discussion (or alternatively, create a separate proposal for that)?

Copy link
Member Author

Choose a reason for hiding this comment

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

+1, I'll update the doc to clarify the plan for adding guides on top of this get started. I also want to make sure that this proposal aligns with #448

Copy link
Member Author

Choose a reason for hiding this comment

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

@fjuma @emmartins @darranl, I reformulated this proposal so that #448 handle the subsequent guides with the requirement that it must comply with this "get started" and be applied to it.

Copy link
Contributor

Choose a reason for hiding this comment

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

hi @jmesnil , if I understood correctly you are proposing that here we focus only on getting the user started (with an app that we provide), since #448 will focus on app development?

Copy link
Member Author

Choose a reason for hiding this comment

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

In this "get started" guide, we will provide the user a ready-to-use Maven project (using the archetype).

The guide from #448 has a section "How to develop a first basic application". The output of following these instructions must result in the same project structure that the one in the "get started" guide.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks, Jeff! Just FYI, for the use-case driven guides, we'll want to look into modularization so that common pieces of user stories can be shared easily across guides, without needing to re-write the same content for multiple guides. As an example, there could be content that can be reused for both OpenShift related and k8s related guides, there could be content that can be reused for both WildFly and EAP, etc.

@theashiot has been starting to look into how we could go about modularizing content.

Proposal to improve the get started experience with WildFly, its
related resources and changes to the wildfly.org web site to promote a fresh modern way to develop
Entreprise Java applications with WildFly.

JIRA: https://issues.redhat.com/browse/WFLY-18428

Signed-off-by: Jeff Mesnil <[email protected]>
@jmesnil jmesnil force-pushed the WFLY-18428_get_started_with_wildfly branch from 32e9809 to 7d606c3 Compare September 12, 2023 08:05
@jmesnil jmesnil merged commit e03ef20 into wildfly:main May 22, 2024
@jmesnil
Copy link
Member Author

jmesnil commented May 22, 2024

Merging the proposal as https://www.wildfly.org/get-started/ is live

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants