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

Add Javadoc for WildFly Elytron 2.2.2.Final for EAP8 #2238

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

Bhargavijanga58
Copy link

PR Description:
This PR includes the addition of the Javadoc for WildFly Elytron 2.2.2.Final for EAP8. Below are the steps taken to generate and include the Javadoc in the WildFly Elytron website:

Checkout the 2.2.2.Final Tag:
The wildfly-elytron repository was checked out to the 2.2.2.Final tag to generate the Javadoc for this specific release.

Build WildFly Elytron:
The project was built using Maven with the mvn clean install -DskipTests=true command to skip tests and generate the necessary build artifacts.

Generate the Public API Javadoc:
The public API Javadoc was generated using the mvn javadoc:aggregate@api-javadoc command, and the built Javadoc files were located in the target/site/apidocs/api-javadoc directory.

Update WildFly Elytron Website:

Forked and cloned the WildFly Elytron website repository from GitHub.
The wildfly-elytron repository was checked out to the develop branch.
Created a new directory under documentation/api named eap8 to store the generated Javadoc for EAP8.

Copy Javadoc Files:
The generated Javadoc files were copied from the target/site/apidocs/api-javadoc directory into the newly created documentation/api/eap8 directory in the WildFly Elytron website repository.

Commit and Push Changes:
After copying the files, the changes were committed and pushed to the develop branch of the forked repository.

Summary of Changes:
Added Javadoc for WildFly Elytron 2.2.2.Final for EAP8 to the documentation/api/eap8 directory in the WildFly Elytron website repository.
The changes include the full Javadoc documentation for the public API.
Please review the PR for the updates to the website documentation for EAP8 Javadoc.

@fjuma
Copy link
Contributor

fjuma commented Nov 21, 2024

Hi @Bhargavijanga58, thank you very much for this PR! Apologies for the delayed response! We'll take a closer look at this PR as soon as we can. Thanks again.

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.

2 participants