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

The Add to an existing application section in the Get Started page is out-dated #3329

Closed
gkwan-ibm opened this issue Aug 18, 2023 · 11 comments · Fixed by #3396, #3401 or #3443
Closed

The Add to an existing application section in the Get Started page is out-dated #3329

gkwan-ibm opened this issue Aug 18, 2023 · 11 comments · Fixed by #3396, #3401 or #3443
Assignees

Comments

@gkwan-ibm
Copy link
Member

gkwan-ibm commented Aug 18, 2023

What is the purpose of the Add to an existing application section?

Nowadays, use LMP to get the OL for development.

If this section want users to know how to specify the OL version for LMP, the Maven and Gradle dependency are out-dated.

If this section is for other purpose, suggest to make it clear.

Also this section points users to Maven and Gradle guides. Both guides do not have dependency for OL.

@github-project-automation github-project-automation bot moved this to New (Untriaged) in Website backlog Aug 18, 2023
@cherylking
Copy link
Member

I think it is better for this doc to just point to the plugins and the guides and not suggest that they add the dependency for the Liberty runtime to their build file, as that is not how it is usually done. If it is for the end user to know the coordinates, then document it that way. These are the coordinates that can be used in the Liberty Maven/Gradle plugin configuration to use the Liberty runtime.

@steven1046
Copy link
Member

Note: Long thread in slack with more information

@cherylking
Copy link
Member

Liberty Maven plugin configuration - no need to configure the Liberty runtime as it gets the latest openliberty-kernel release automatically:

<plugin>
    <groupId>io.openliberty.tools</groupId>
    <artifactId>liberty-maven-plugin</artifactId>
    <version>3.8.2</version>
</plugin>

The 3.8.2 version should be replaced with the latest version found in Maven Central here.

@cherylking
Copy link
Member

cherylking commented Sep 5, 2023

Liberty Gradle plugin configuration - no need to configure the Liberty runtime as it gets the latest openliberty-kernel release automatically:

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'io.openliberty.tools:liberty-gradle-plugin:3.6.2'
    }
}

The plugin also needs to be applied in the build file in order to be utilized.

apply plugin: 'liberty'

The 3.6.2 version should be replaced with the latest version found in Maven Central here.

@steven1046 steven1046 moved this from New (Untriaged) to In Development in Website backlog Sep 6, 2023
@mbroz2
Copy link
Member

mbroz2 commented Sep 15, 2023

The blog post release templates have been updated to reflect the above.

@SteveSamJacob19 SteveSamJacob19 linked a pull request Sep 29, 2023 that will close this issue
3 tasks
@SteveSamJacob19 SteveSamJacob19 moved this from In Development to In Testing/Review in Website backlog Sep 29, 2023
@SteveSamJacob19 SteveSamJacob19 linked a pull request Oct 3, 2023 that will close this issue
3 tasks
@natalie-bernhard
Copy link
Contributor

@dmuelle

@steven1046
Copy link
Member

@dmuelle
Copy link
Member

dmuelle commented Oct 5, 2023

we could break then out into 2 separate calls to action for each tool

  • Ready to get started using Maven with Open Liberty? Try the [Building a web application with Maven] guide.
  • Looking for information about Open Liberty Maven configuration, goals, and more? Check out the [Liberty Maven plugin documentation on GitHub].

  • Ready to get started using Gradle with Open Liberty? Try the [Building a web application with Gradle] guide.
  • Looking for information about Open Liberty Gradle configuration, tasks, and more? Check out the [Liberty Gradle plugin documentation on GitHub].

@dmuelle
Copy link
Member

dmuelle commented Oct 5, 2023

We might want to add some kind of intro statement for the plugin just under the Add to an existing application header. As it it now, we have this sentence between the two examples:

The plugin also needs to be applied in the build file in order to be utilized.

but we haven't said anything about a plugin or introduced it in any way. Something like

Open Liberty provides build plugins for Maven and Gradle that simplify the installation and operational control of the Liberty runtime and servers.

and i think this sentence could be improved

The plugin also needs to be applied in the build file in order to be utilized.
--->
You must also apply the plugin in the build file before you can use it:

@natalie-bernhard
Copy link
Contributor

Opened Issue #3449 to improve the wording as the code snippets have now been updated. Closing this issue as complete.

@github-project-automation github-project-automation bot moved this from In Testing/Review to Closed/Done in Website backlog Oct 17, 2023
@natalie-bernhard natalie-bernhard linked a pull request Oct 17, 2023 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment