Rearrage docs, add faq for thin jars #401
Conversation
loosebazooka
force-pushed
the
rearrange-docs
branch
from
9c45b9f
to
33b2ad9
Compare
README.md
Outdated
| appengine:help|Displays help information on the plugin. Use `mvn appengine:help -Ddetail=true -Dgoal=[goal]` for detailed goal documentation. | ||
| Please see the [USER GUIDE](USER_GUIDE.md) for a full list of supported goals and configuration | ||
| options. | ||
| * [for app.yaml based projects](USER_GUIDE.md#app-engine-appengine-webxml-based-projects) |
There was a problem hiding this comment.
These two links are reversed
There was a problem hiding this comment.
whoops, good catch
USER_GUIDE.md
Outdated
| @@ -368,4 +368,41 @@ The plugin defaults to `appengine-web.xml` based deployment if your project cont | |||
| file. If your project also has an `src/main/appengine/app.yaml` file and you wish to use that, you may temporarily move the | |||
| `appengine-web.xml` file to a different location before deploying. | |||
|
|
|||
| ### How do I deploy an `app.yaml` based thin jar to appengine? | |||
USER_GUIDE.md
Outdated
| @@ -368,4 +368,41 @@ The plugin defaults to `appengine-web.xml` based deployment if your project cont | |||
| file. If your project also has an `src/main/appengine/app.yaml` file and you wish to use that, you may temporarily move the | |||
| `appengine-web.xml` file to a different location before deploying. | |||
|
|
|||
| ### How do I deploy an `app.yaml` based thin jar to appengine? | |||
|
|
|||
| You will probably need to stage the application to include it's dependencies. You might use something like the | |||
There was a problem hiding this comment.
I rewrote this whole thing, can you take another look?
README.md
Outdated
| @@ -9,29 +9,12 @@ This Maven plugin provides goals to build and deploy Google App Engine applicati | |||
| | :------------------------------ | | |||
| | 2.0.0 has been published. The behavior of the appengine-maven-plugin has changed since v1.+; please see the [CHANGELOG](CHANGELOG.md) for a full list of changes and an updated [USER GUIDE](USER_GUIDE.md) for details. If you are having trouble using or updating your plugin, please file a [new issue](https://github.com/GoogleCloudPlatform/app-maven-plugin/issues).| | |||
There was a problem hiding this comment.
Should this section say 2.1.0 now, or is it fine to leave it as 2.0.0 since it's focused on v1 -> v2 migration?
There was a problem hiding this comment.
I think I can take this down and make it a section below. It's already been like 5 months since 2.0.0
There was a problem hiding this comment.
actually, I'm just going to remove it and do nothing.
USER_GUIDE.md
Outdated
| </plugin> | ||
| ``` | ||
|
|
||
| Then when you run `mvn package appengine:deploy` the dependencies are copied and included as part of the deployment |
There was a problem hiding this comment.
Missing period at the end
|
|
||
| ``` | ||
| runtime: java11 | ||
| entrypoint: java -Xmx64m -cp "*" com.example.MyMainClass |
There was a problem hiding this comment.
Is -Xmx64m recommended for App Engine? If not, remove it?
There was a problem hiding this comment.
That's a good point, it was in the example on the appengine docs, so I used it.
| </plugin> | ||
| ``` | ||
|
|
||
| Then when you run `mvn package appengine:deploy` the dependencies are copied and included as part of the deployment. |
There was a problem hiding this comment.
I could be wrong about this, but just in case:
I think a lot of frameworks nowadays will by default create a fat JAR, so maybe it'd be nice to explain a bit for those cases to deploy an app correctly. For example, Spring Boot will generate two JARs (fat one and the original one), and isn't it that this command will copy the fat JAR to the staging area (or both)?
BTW, there seems to be a working hack the user and @ludoch used to remove a fat JAR.
There was a problem hiding this comment.
Yes, I think I might lean towards thinking that that's on them. For springboot, in maven, I believe some of the configurations leads to it overriding the default final artifact as the springboot fat jar (but I could be wrong about the exact mechanism).
You can see the rendered docs on the branch: