Merge pull request #85 from awisniew90/reduce_readme

Simplify readme

Author: awisniew90

README.md

@@ -19,194 +19,69 @@
 
 A devfile-based application stack for Open Liberty
 
-## Contributing
-
-Our [CONTRIBUTING](https://github.com/OpenLiberty/application-stack/blob/master/CONTRIBUTING.md) document contains details for submitting pull requests.
-
 # Open Liberty Application Stack
 
 The Open Liberty application stack provides a consistent way of developing microservices based upon the [Jakarta EE](https://jakarta.ee/) and [Eclipse MicroProfile](https://microprofile.io) specifications. This stack lets you use [Maven](https://maven.apache.org) to develop applications for [Open Liberty](https://openliberty.io) runtime, that is running on OpenJDK with container-optimizations in OpenJ9.
 
-This stack is based on OpenJDK with container-optimizations in OpenJ9 and `Open Liberty v20.0.0.9`. It provides live reloading during development by utilizing the ["dev mode"](https://openliberty.io/blog/2019/10/22/liberty-dev-mode.html) capability in the liberty-maven-plugin.  
+This stack is based on OpenJDK with container-optimizations in OpenJ9 and Open Liberty. It provides live reloading during development by utilizing the ["dev mode"](https://openliberty.io/blog/2019/10/22/liberty-dev-mode.html) capability in the liberty-maven-plugin.  
 
 **Note:** Maven is provided by the stack, allowing you to build, test, and debug your Java application without installing Maven locally.
 
-## Default starter app
-
-The default starter provides a `pom.xml` file that enables Liberty features that support [Eclipse MicroProfile 3.3](https://openliberty.io/docs/ref/feature/#microProfile-3.3.html). Specifically, this template includes:
-
-#### Health
-
-The `mpHealth` feature allows services to report their readiness and liveness status - UP if it is ready or alive and DOWN if it is not ready/alive. It publishes two corresponding endpoints to communicate the status of liveness and readiness. A service orchestrator can then use the health statuses to make decisions.
-
-Liveness endpoint: http://localhost:9080/health/live
-Readiness endpoint: http://localhost:9080/health/ready
-
-#### Metrics
-
-The `mpMetrics` feature enables MicroProfile Metrics support in Open Liberty. Note that this feature requires SSL and the configuration has been provided for you. You can monitor metrics to determine the performance and health of a service. You can also use them to pinpoint issues, collect data for capacity planning, or to decide when to scale a service to run with more or fewer resources.
-
-Metrics endpoint: http://localhost:9080/metrics
-
-##### Metrics Password
-
-Security for the development image is enabled via Open Liberty's `<quickStartSecurity>` configuration. This mechanism provides a basic username/password to the server and is intended for development. It is intentionally removed when an official production image is built.
-
-Log in as the `admin` user to see both the system and application metrics in a text format.   The password for this `admin` user will be generated by the container.  
-
-To get the generated password for your project, you can exec in the container with these steps:
-
-1. List the name of the pod running in the current namespace:
-
-    $ kubectl get pods
-
-1. Use the oc tool to open a remote session to your pod, and print the keystore_password created for the Open Liberty server:
-
-    $ oc rsh <pod_name>
-    $ grep keystore /projects/target/liberty/wlp/usr/servers/defaultServer/server.env
-
-    keystore_password=2r1aquTO3VVUVON7kCDdzno
-
-So in this example the password value would be: `2r1aquTO3VVUVON7kCDdzno`
-
-
-#### Junit 5
-
-The default template uses JUnit 5. You may be used to JUnit 4, but here are some great reasons to make the switch https://developer.ibm.com/dwblog/2017/top-five-reasons-to-use-junit-5-java/
-
-
 ## Getting Started
 
-1. Perform an `oc login` to your Open Shift cluster for development purposes.
+> It's recommended to use the latest version of OpenShift Do (odo). You can install odo using [these instructions](https://odo.dev/docs/installing-odo/)
+
+1. Perform an `oc login` to your cluster.
 
-1.  Install the latest vesion of OpenShift Do (odo) using [these instructions](https://odo.dev/docs/installing-odo/)
+1. Create a new odo project
 
-    <!-- Keep for now in case future changes require experimental mode
-    1. Odo must be run in experimental mode at the 1.x level in order to access the devfile support. Enable experimental mode using the odo CLI:
     ```shell
-    odo preference set experimental true
+    odo project create my-project
     ```
-    --->
 
-1. Create a new folder in your local directory and create an odo project using the odo CLI, e.g.:
+    This will create a new namespace in your cluster called `my-project`
+
+1. Initialize the local folder with the Open Liberty stack
+
     ```shell
     mkdir my-project
     cd my-project
-    odo project create <project namespace name>
-    ```
-    The project namespace name will be used to create an OpenShift namespace that will house your application and related pods
-
-1. Initialize the local folder using the Open Liberty stack.
-    ```shell
     odo create java-openliberty --starter
     ```
 
-    This will initialize an Open Liberty project and download the default starter app artifacts.
+    This will download the default starter app
 
-1. Once your project has been initialized, you can push your application to your OpenShift cluster for the first time using the following command:
+1. Push your app to your cluster
 
     ```shell
     odo push
     ```
 
-    Upon a first time `odo push` invocation, the following occurs:
-    - An Open Shift managed kubernetes pod is launched within the namespace created in step 3 above,
-    - A container based on the image referenced in the devfile is started in that pod
-    - odo syncs your local source code directory to that container. (under the `/projects` directory)
-    - The app is compiled and built within the container and liberty dev mode is started to host the app once built.
-    - A URL is activated and is usable to access the app
-
-1. Retrieve the URL for your app using the odo CLI:
+1. Retrieve the URL for your app
 
     ```shell
     odo url list
     ```
 
-1. You should be able to access the following endpoints, as they are exposed by your template application by default:
-
-    - Readiness endpoint: http://`<odo url>`/health/ready
-    - Liveness endpoint: http://`<odo url>>`/health/live
-    - Metrics endpoint: http://`<odo url>`/metrics (login as `admin` user with password obtained as mentioned [here](#Metrics-Password).
-
-To see source code changes reflected in the running application you can re-issue the `odo push` command after any edit session is complete and saved. Source code changes will be reflected in the running container within a few seconds. Alternatively, you can issue `odo watch` once which will monitor for changes in your local project and automatically push changes to your remote cluster.
-
-## Creating a project from an existing application
-
-You can initialize an existing application as a stack project. The following steps show how to do this using the Open Liberty [application-stack-intro sample application](https://github.com/OpenLiberty/application-stack-intro).
-
-1. Clone the application-stack-intro repository
-
-```shell
-git clone [email protected]:OpenLiberty/application-stack-intro.git
-cd application-stack-intro
-```
-
-2. Initialize the project with the java-openliberty stack
-
-```shell
-odo create java-openliberty my-component
-```
-
-3. Push the sample application to OpenShift
-
-```shell
-odo push
-```
-
-For more details on the application-stack-intro application, check out https://github.com/OpenLiberty/application-stack-intro
-
-## Odo development operations
+    This URL will show the starter app's welcome page by default.
 
-### PUSH
-By default, `odo push`, in conjuction with the java-openliberty devfile, runs a liberty:dev mode in "hot test" mode, where unit tests and integration tests get automatically re-executed after each detected change. These test results are visible in the OpenShift container logs. To see the realtime contents of the container logs, use the odo CLI:
-```shell
-odo log
-```
+1. Watch for changes in your local project
 
-It is also possible to disable the "hot test" mode of liberty:dev mode by re-running the `odo push` with the following argument:
-```shell
-odo push --run-command=run-test-off
-```
-
-### DEBUG
-
-The Open Liberty stack has a built in "debug mode". This allows you to connect a debugger to your application running in your cluster. To invoke debug mode, issue the following:
-
-```shell
-odo push --debug
-odo debug port-forward
-```
-
-These commands enable "debug" mode in the underlying Open Liberty server as well as forwarding the default odo debug port of 5858. Once complete, you can connect a debugger from your local workstation.
-
-Additionally, you can override the local port used for debugging with the following option on the `odo debug port-forward` command:
-
-```shell
-odo debug port-forward --local-port=7777
-```
-
-
-### TEST
-
-Once your application container is up and running after an `odo push`, you can force a run of any integration tests that you have for your project. The Open Liberty stack runs the Maven failsafe integration-test goal (`failsafe:integration-test`) to invoke your project's tests using the MicroShed Testing (MST) framework.
-
-To do this, enter the following:
-
-```shell
-odo test --show-log
-```
+    ```shell
+    odo watch
+    ```
 
-## ODO deployment operations
+You can now begin developing your app! Changes will be detected and pushed automatically.
 
-### DEPLOY
+For more details on using the starter app, checkout https://github.com/OpenLiberty/application-stack/wiki/Using-the-Default-Starter-Application
 
-Once your development is done, you can "deploy" your code using the `odo deploy` command. This creates a production ready image for your application based on the official Open Liberty image in Dockerhub and deploys it to a specified namespace.
+## User Doc
 
-**NOTE!!!** This is currently included in PR https://github.com/openshift/odo/pull/3478. To use this support, the remote PR branch must be built locally.
+Checkout the application-stack [wiki](https://github.com/OpenLiberty/application-stack/wiki) for details on using the Open Liberty stack.
 
-<!-- Add link to deploy guide once completed -->
+## Contributing
 
-<!-- odo pipeline? -->
+Our [CONTRIBUTING](https://github.com/OpenLiberty/application-stack/blob/master/CONTRIBUTING.md) document contains details for submitting pull requests.
 
 ## License