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.

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

Modernize documentation #289

Closed
m-reza-rahman opened this issue Feb 6, 2024 · 5 comments
Closed

Modernize documentation #289

m-reza-rahman opened this issue Feb 6, 2024 · 5 comments
Assignees
@Ndacyayisenga-droid
Labels
documentation Improvements or additions to documentation Priority: Trivial

Comments

@m-reza-rahman
Copy link
Contributor

The documentation for the project currently uses the Wiki. While this is workable, it can be significantly improved. The goal is to move the documentation to either GitBook or AsciiDoc/Antora in line with the official Jakarta EE Tutorial.
@m-reza-rahman m-reza-rahman added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers Priority: Trivial backlog Items yet to be prioritized in the longer term roadmap. labels Feb 6, 2024
@m-reza-rahman m-reza-rahman changed the title Modernize Documentation Modernize documentation Feb 6, 2024
@m-reza-rahman m-reza-rahman removed help wanted Extra attention is needed good first issue Good for newcomers labels Feb 18, 2024
@m-reza-rahman
Copy link
Contributor Author

This is currently submitted as a project idea to be included as an Eclipse Foundation project with Google Summer of Code: https://gitlab.eclipse.org/eclipsefdn/emo-team/gsoc-at-the-ef/-/issues/8. Anyone wanting to work on this should be submitting through Google Summer of Code when it actually starts.

@krishna-Gokul-g
Copy link

I like to work on this and I will wait until the Gsoc process starts.

@m-reza-rahman
Copy link
Contributor Author

Can you please check if you can assign this to yourself, @Ndacyayisenga-droid?

@m-reza-rahman m-reza-rahman removed the backlog Items yet to be prioritized in the longer term roadmap. label May 16, 2024
@Ndacyayisenga-droid
Copy link
Contributor

Can you please check if you can assign this to yourself, @Ndacyayisenga-droid?

@m-reza-rahman I dont have the rights!

@m-reza-rahman
Copy link
Contributor Author

Completed: https://jakarta.ee/learn/docs/cargotracker-documentation/current/index.html

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

@Ndacyayisenga-droid Ndacyayisenga-droid

Labels
documentation Improvements or additions to documentation Priority: Trivial
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@m-reza-rahman @Ndacyayisenga-droid @krishna-Gokul-g