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

Refresh the Platform Basics section #59

Open
kito99 opened this issue Sep 21, 2023 · 0 comments
Open

Refresh the Platform Basics section #59

kito99 opened this issue Sep 21, 2023 · 0 comments
Labels
help wanted Extra attention is needed

Comments

@kito99
Copy link

kito99 commented Sep 21, 2023

Refresh is our term for rewriting/reorganizing/updating.

Please do the following:

  • Add an introduction to the chapter; this should be display directly from the root nav (src/main/antora/modules/ROOT/nav.adoc). (For example, when someone clicks on the left-hand "Platform Basics" link in the navigation, the introduction should be displayed.
  • Update prose/voice as per the Contributing guide.
  • Remove EAR section
  • Remove Glassfish-specific content
  • Add a section that explains "fat" JAR packaging. Even though this isn't explicitly in the spec, it's supported by several runtimes, and many developers may only be familiar with this option.

Open issues that may need to be addressed:

Errata in packaging002 · Issue #142 · eclipse-ee4j/jakartaee-tutorial

Idea for the new term reference in the whole doc · Issue #232 · eclipse-ee4j/jakartaee-tutorial

Ambiguous using of word "resource" in the paragraph "3.1. Resource Creation". · Issue #247 · eclipse-ee4j/jakartaee-tutorial

By my opinion - it's missed one word at the end of the first sentence of the "3.1.3. Creating Resources Administratively" paragraph. · Issue #248 · eclipse-ee4j/jakartaee-tutorial

Section "Packaging Resource Adapter Archives" contains redundant and repetitive information. · Issue #254 · eclipse-ee4j/jakartaee-tutorial

Small correction in "Packaging and Deploying the hello1 Web Module" section. · Issue #256 · eclipse-ee4j/jakartaee-tutorial

@kito99 kito99 self-assigned this Sep 21, 2023
@kito99 kito99 added this to the Content Modernization milestone Oct 23, 2023
@kito99 kito99 added the help wanted Extra attention is needed label Dec 14, 2023
@kito99 kito99 removed their assignment Dec 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
Status: 🔖 Ready
Development

No branches or pull requests

1 participant