Merge branch 'master' into jcberger_1850_configpro

Author: micgibso

docs/_config.yml

@@ -3,9 +3,6 @@ email: codewind-dev@eclipse.org
 description: Eclipse Codewind
 keywords: Eclipse, docker, container, devops, applications, development, iteration, microservices, cloud, services, rapid, integrated
 baseurl: "/codewind"
-twitter_username: jekyllrb
-github_username:  jekyll
-
 
 # Build settings
 markdown: kramdown

docs/_data/docstoc.yml

@@ -1,4 +1,4 @@
-- title: 'Overview'
+- title: 'What is Codewind?'
   url: overview.html
 
 - title: 'Getting started'
@@ -30,14 +30,10 @@
         url: mdt-che-createcodewindworkspace.html
       - title: 'Setup to use Tekton Pipelines'
         url: mdt-che-tektonpipelines.html
-      - title: 'Set Docker registries'
-        url: mdt-che-dockerregistries.html
       - title: 'Using Codewind in Theia'
         url: mdt-che-usingtheia.html
       - title: 'OpenShift Do (odo) support in Codewind'
         url: mdt-che-odo-support.html         
-      - title: 'Docker Registry Guidance'
-        url: image-registry-credentials.html
       - title: 'Using the OpenShift Registry'
         url: openshiftregistry.html
       - title: 'Support for multiple users'
@@ -46,6 +42,10 @@
         url: viewkibanalogs.html
       - title: 'Uninstalling Codewind for Eclipse Che'
         url: mdt-che-uninstall.html
+    - title: 'IntelliJ'
+      children:
+      - title: 'Installing Codewind for IntelliJ'
+        url: mdt-intellij-getting-started.html
 
 - title: 'Local to remote development'
   children:
@@ -67,14 +67,14 @@
 
 - title: 'Developing projects'
   children:
-    - title: 'Using the project view'
-      url: projectview.html
     - title: 'Checking the application and build statuses'
       url: checkingstatuses.html
     - title: 'Importing existing projects'
       url: importing-existing-projects.html
     - title: 'Project settings'
       url: project-settings.html 
+    - title: 'Referencing files external to a project'
+      url: referencing-files.html
 
 - title: 'Performance monitoring'
   children:

docs/_documentations/appmetrics.md

@@ -25,7 +25,7 @@ Application Metrics is available in Java, Node.js, and Swift. You can monitor th
 
 ## Accessing Application Metrics
 
-Click **App monitor** in the Microclimate project to access Application Metrics. Toggle between the **Dashboard** and **Summary** tabs. If you have a Node.js project, you can also access the **Profiling** tab.
+Click **App monitor** in the Codewind project to access Application Metrics. Toggle between the **Dashboard** and **Summary** tabs. If you have a Node.js project, you can also access the **Profiling** tab.
 
 ## Enabling Application Metrics
 
@@ -45,35 +45,35 @@ View these metrics to learn if your application is performing as intended. An ap
 
 ## Clicking the **Run load** button
 
-Click the **Run load** button to run load your microservice. This button pings endpoints by using the Microclimate load runner service.
+Click the **Run load** button to run load your microservice. This button pings endpoints by using the Codewind load runner service.
 
 ## Viewing metrics information in the **Summary** tab
 
 View a summary of the information from the performance metrics graphs that you saw in the **Dashboard** tab.
 * **HTTP Requests:** This table displays how many times an endpoint is hit. If you repeatedly run a test while making code changes, you can see how the code changes are impacting application performance.
 * **Environment:** This table shows information about the environment you're running, such as the OS architecture and the number of processors you have. Having this information can make troubleshooting easier if you need to contact support and provide it.
-* **Resource usage:** This table shows the **Average Process CPU**, which shows what Microclimate is doing, and the **Average System CPU**, which shows what the environment as a whole is doing. This information can help determine whether application issues are caused by something else in the environment that is external to the application.
+* **Resource usage:** This table shows the **Average Process CPU**, which shows what Codewind is doing, and the **Average System CPU**, which shows what the environment as a whole is doing. This information can help determine whether application issues are caused by something else in the environment that is external to the application.
 
 ## Viewing the graph in the **Profiling** tab
 
 The **Profiling** tab is available only in Node.js projects. This tab pulls information from the CPU metric in the **Dashboard** tab. CPU cycles are caused by an execution of code. Receiving an endpoint doesn't cause many CPU cycles, but receiving an incoming payload can. Profiling shows you what occurs when a spike appears in the CPU metric. Each spike on the flame graph shows a call stack in the path. The width of a spike indicates how much time the CPU spends on a function. Wide spikes indicate that your CPU spends much time on a particular function and where you might want change the code to optimize it.
 
 ## Profiling Data Support
 
-In Theia or VS Code, you can use the Profiling Language Server to provide code highlighting. Code highlighting displays the relative time spent in JavaScript functions based on profiling data gathered through [Microclimate load testing](performancetesting). Profiling support is only available for Node.js projects that are created through Microclimate and then profiled.
+In Theia or VS Code, you can use the Profiling Language Server to provide code highlighting. Code highlighting displays the relative time spent in JavaScript functions based on profiling data gathered through [load testing](performance). Profiling support is only available for Node.js projects that are created through Codewind and then profiled.
 
 - Profiling data is written to the workspace only on a successfully completed load run. If the load run is cancelled, it won't be written to the workspace.
 - Run the load run for a minimum of 45 seconds for enough profiling data to be gathered to generate the `profiling.json` file.
 - You can configure the load run time in the `config.json` file in the `load-test` directory. The default time is 2 minutes.
 - Out of all the folders that contain a `profiling.json` file, the most up-to-date `profiling.json` file is the one that is displayed. The code for the older profiling data might be out of date, such as pointing to lines that have been moved.
 
 To display code highlighting:
-1. Open a project created with Microclimate and profiled using the [performance testing](performancetesting) feature of Microclimate. Profiling data is created in a `load-test/<datestamp>/profiling.json` file in your Microclimate project.
+1. Open a project created with Codewind and profiled using the [performance testing](performance) feature of Codewind. Profiling data is created in a `load-test/<datestamp>/profiling.json` file in your Codewind project.
 2. In the **Editor** view, open a JavaScript file. The Editor highlights any lines that were found in the profiling data and annotates them to show how often they were seen and where they were called from.
 
 To enable or disable the profile highlighting in the code, access the profiling in one of the following ways:
 - Right-click in the editor and select `Toggle Profiling`.
-- Open the command palette with `cmd+shift+p` on a Mac or `ctrl+shift+p` on Windows. Then, select `Microclimate: Profiling: Toggle Profiling`.
+- Open the command palette with `cmd+shift+p` on a Mac or `ctrl+shift+p` on Windows. Then, select `Profiling: Toggle Profiling`.
 - Toggle the `Microprofile Profiling: Show Profiling` setting in the extensions settings.
 
 For more information on sample-based profiling, see [Sample-based profiling](https://www.ibm.com/support/knowledgecenter/en/SS3KLZ/com.ibm.java.diagnostics.healthcenter.doc/topics/profiling_using.html).

docs/_documentations/importing-existing-projects.md

@@ -122,7 +122,7 @@ Configure your `pom.xml` file as follows:
 
 The following files are generated during the import process. If your project requires additional configuration files or instructions for build, you might need to modify them.
 
-**Note:** Only Microprofile projects enable the use of `Dockerfile-lang` and `Dockerfile-build` files.
+**Note:** Only MicroProfile projects enable the use of `Dockerfile-lang` and `Dockerfile-build` files.
 
 **Dockerfile-lang**
 
@@ -146,7 +146,7 @@ Requirements:
 - The `artifactId` value in the `pom.xml` file must match the project name.
 - Configure the project to build with Maven and produce a exectutable `.jar` file.
 - Configure the application to use port 8080.
-- Copy the executable `.jar` file produced by the Maven build to `/app.jar` within the Docker container. To do this, simply add a `COPY` instruction to the Dockerfile. If your project does not have a Dockerfile, one is generated for you.
+- Copy the executable `.jar` file produced by the Maven build to `/app.jar` within the Docker container. To do this, simply add a `COPY` instruction to the Dockerfile.
 
 Example:
 
@@ -172,21 +172,21 @@ Your `package.json` must meet the following requirements. For an example of a go
     - If a problem occurs with either script, the error appears in the Application Logs view in Codewind.
 
 If you have a `Dockerfile`, it must meet the following requirements:
-- A `Dockerfile` is generated if it does not exist. Ensure the `Dockerfile` exposes your application port.
+- Ensure the `Dockerfile` exposes your application port.
     - For example, if you're using port 3000, the `Dockerfile` needs to include `EXPOSE 3000`.
 - Ensure that the application is located in the `/app` directory within the Docker container.
 - Ensure that the `Dockerfile` sets the working directory to `/app` with `WORKDIR "/app"`.
+- For more information about Dockerfiles, see [Dockerfile reference](https://docs.docker.com/engine/reference/builder/).
 
 ## Swift projects
 
 Codewind works with Swift projects that use the Kitura web framework.
 
 Requirements:
 
-- A `Dockerfile-tools` file is generated to build the project. Ensure the project can be built by using a `release` build configuration.
+- Ensure the project can be built by using a `release` build configuration.
 
 For example, you can build the project by using the command: `swift build --configuration release`.
-- A `Dockerfile` file is generated. It runs the application that was built by using `Dockerfile-tools`.
 
 ## Generic Docker projects
 
@@ -200,6 +200,6 @@ For more information about Appsody and Appsody stacks, see [https://appsody.dev]
 #### Defining environment variables for Appsody projects
 Complete the following steps to define environment variables that take effect in an Appsody application:
 1. Create an `env.properties` file in the root of the Appsody project.
-   - **Caution:** Do not commit the `env.properties` file to your source repository if it contains confidential information, such as passwords.
+   - **Caution:** Do not commit the `env.properties` file to your source repository if it contains confidential information, such as passwords. To avoid including sensitive information in your project, you can include the `env.properties` file as a reference, for more information, see [Referencing files external to a project](referencing-files.html).
 2. Define your environment variables in this file by using the standard properties format. This format features one `name=value` entry per line.
 3. If autobuild is enabled, Codewind automatically rebuilds the project to pick up the environment values. If autobuild is not enabled, new values take effect the next time you rebuild the project.

docs/_documentations/mdt-che-createcodewindworkspace.md

@@ -1,28 +1,25 @@
 ---
 layout: docs
-title: Installing Codewind on the Cloud
-description: Installing Codewind on the Cloud
-keywords: build, deploy, IBM Cloud Private, install, installing, installation, chart, Helm, develop, cloud, public cloud, services, command line, cli, command, start, stop, update, open, delete, options, operation, devops, OpenShift, OKD
+title: Creating a Codewind workspace in Che
+description: Creating a Codewind workspace in Che
+keywords: build, deploy, install, installing, installation, chart, Helm, develop, cloud, public cloud, services, command line, cli, command, start, stop, update, open, delete, options, operation, devops
 duration: 1 minute
 permalink: mdt-che-createcodewindworkspace
 type: document
-order: 20
-parent: root
 ---
 
-### Creating the Codewind workspace with a Devfile
-The general format for creating a Che workspace via a factory is:
-```
-http://<che ingress domain>/f?url=<hosted devfile URL>
-```
+# Creating a Codewind workspace in Che
+Use Codewind with Che workspaces to develop your application in a single location.
 
-Codewind includes a ready-to-use devfile with its plug-ins. Enter the following URL to create a workspace from the devfile:
-```
-http://<che ingress domain>/f?url=https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.8.0/devfiles/0.8.0/devfile.yaml
-```
+### Creating the Codewind workspace with a devfile
+Codewind includes a ready-to-use devfile with its plug-ins. 
+1. Log in to Che. Che loads.
+2. Go to **Workspaces** and click **Add Workspace**.
+3. Click **Import Devfile**.
+4. From **Source**, click **YAML**.
+5. Go to the [https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.9.0/devfiles/0.9.0/devfile.yaml](https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.9.0/devfiles/0.9.0/devfile.yaml) link and copy and paste the contents into the YAML text box in your Che workspace.
+6. Click **Create & Open**.
 
-For other sample devfiles, see https://github.com/kabanero-io/codewind-templates/tree/master/devfiles.
+For more sample devfiles, see [`codewind-templates/devfiles/`](https://github.com/kabanero-io/codewind-templates/tree/master/devfiles).
 
 Next step: [Setup Tekton Pipelines](mdt-che-tektonpipelines.html)
-
-

docs/_documentations/mdt-che-dockerregistries.md

@@ -10,8 +10,8 @@ order: 20
 parent: root
 ---
 
+# Setting the Docker registry
 
-### Setting the Docker registry
 After creating a Codewind workspace, you must set the container registry to deploy your projects. When you go to create or add an existing project to Codewind, Codewind will prompt you for the registry. See [Docker registry docs](https://www.eclipse.org/codewind/dockerregistry.html) for guidance on using proper container registries.
 
 If you would like to change the registry that's used at any time, run the `Codewind: Set Deployment Registry` command in Theia to dynamically set a new registry for your workspace. <br>

docs/_documentations/mdt-che-installinfo.md

@@ -9,9 +9,11 @@ type: document
 ---
 
 # Installing Codewind for Eclipse Che
+
 Install Che to use with Codewind or use Codewind with an existing Che installation.
 
-### Prerequisites
+## Prerequisites
+
 1. Set up PersistentVolumes (PVs) that support both `ReadWriteOnce` (RWO) and `ReadWriteMany` (RWX) access modes and have a minimum of 1 Gi storage.
    - One volume is required for Che, and two volumes are required for each Codewind workspace.
    - For Network File System (NFS) shares, set 777 permissions for the exported folders and ownership of `nobody:nogroup`.
@@ -20,13 +22,14 @@ Install Che to use with Codewind or use Codewind with an existing Che installati
    - Both Eclipse Che and Eclipse Codewind host Docker images at these locations.
    - Many clusters have image policies that control which registries you can use to pull images. Check your cluster documentation and ensure that the cluster image pull policies permit both of these registries.
 3. Set up the ClusterRole for Codewind:
-`kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.8.0/setup/install_che/codewind-clusterrole.yaml`
+`kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.9.0/setup/install_che/codewind-clusterrole.yaml`
+
+## Installing Che with chectl
 
-### Installing Che with chectl
 The fastest way to install Eclipse Che for Codewind is to use the `chectl` CLI. To install the `chectl` CLI tool, see [Installing the chectl management tool](https://www.eclipse.org/che/docs/che-7/installing-the-chectl-management-tool/).
 
 After you install `chectl`, complete the following steps:
-1. Download the [codewind-checluster.yaml](https://github.com/eclipse/codewind-che-plugin/blob/0.8.0/setup/install_che/che-operator/codewind-checluster.yaml) file.
+1. Download the [codewind-checluster.yaml](https://github.com/eclipse/codewind-che-plugin/blob/0.9.0/setup/install_che/che-operator/codewind-checluster.yaml) file.
     - You can modify this file, but leave the `spec.server.cheWorkspaceClusterRole` field set to `eclipse-codewind` and the `spec.storage.preCreateSubPaths` field set to `true`.
 2. If you're installing Che on a Kubernetes platform other than OpenShift, determine your Ingress domain.
     - Set the `spec.server.ingressDomain` field in the Che `.yaml` file to the Ingress domain.
@@ -35,15 +38,17 @@ After you install `chectl`, complete the following steps:
     - On OpenShift, run the following command: `chectl server:start --platform=openshift --installer=operator --che-operator-cr-yaml=codewind-checluster.yaml --che-operator-image=quay.io/eclipse/che-operator:7.5.1`
     - On Kubernetes, run the following command: `chectl server:start --platform=k8s --installer=operator --domain=<ingress-domain> --che-operator-cr-yaml=codewind-checluster.yaml --che-operator-image=quay.io/eclipse/che-operator:7.5.1`
 
-### Updating an existing Che installation
+## Updating an existing Che installation
+
 If you already have a Che installation, you can update it for Codewind.
 
 After creating the Codewind ClusterRole from the [Prerequisites](#prerequisites), run the following command, where `$NAMESPACE` is the namespace that your Che workspaces run in. By default, this namespace is `che`.
 ```
-kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.8.0/setup/install_che/codewind-rolebinding.yaml -n $NAMESPACE
+kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.9.0/setup/install_che/codewind-rolebinding.yaml -n $NAMESPACE
 ```
 
-### Enabling privileged and root containers to run
+## Enabling privileged and root containers to run
+
 Codewind needs to run as privileged and as root because it builds container images. If your cluster is running OpenShift, run the following commands, where `<che namespace>` is the namespace into which you installed Che.
 1. To enable privileged containers, enter `oc adm policy add-scc-to-user privileged system:serviceaccount:<che namespace>:che-workspace`.
 2. To enable containers to run as root, enter `oc adm policy add-scc-to-user anyuid system:serviceaccount:<che namespace>:che-workspace`.