helidon-io / helidon

Java libraries for writing microservices
https://helidon.io
Apache License 2.0
3.5k stars 566 forks source link

Add a guide for OCI Archetype #8353

Open klustria opened 8 months ago

klustria commented 8 months ago

Problem Description

The Helidon documentation does not have a guide on how to create an OCI project using the Helidon archetype. We have created an external guide like this: https://medium.com/helidon/oci-application-with-helidon-caa78cacaee5, but we need to create a version of this in the Helidon documention.

Goals

  1. Add a documention on how to create an OCI project using the Helidon archetype under the Guide section.
  2. Include mvn artifacts to include in the command line like:
    mvn -U archetype:generate -DinteractiveMode=false \
     -DarchetypeGroupId=io.helidon.archetypes \
     -DarchetypeArtifactId=helidon-quickstart-mp \
     -DarchetypeVersion=4.0.4 \
     -DgroupId=io.helidon.examples \
     -DartifactId=helidon-quickstart-mp \
     -Dpackage=io.helidon.examples.quickstart.mp
  3. Describe the dependencies needed for the POM
  4. Describes the general structure of the application.
  5. Another resource that can be used for guidance is the Unit 12 Appendix from the OU course.
barchetta commented 8 months ago

We should put as much of this information in the archetype itself (in the form of an enhanced README or additional markdown files) rather than in a guide. This puts the information as close to the code as possible which improves the chances that it stays up to date.