Merge pull request #355 from micgibso/landing_page_404s

micgibso · web-flow · commit e27b6e84ffc9 · 2020-02-12T14:53:25.000Z
Correct links check function tweak titles #2010
diff --git a/docs/_data/docstoc.yml b/docs/_data/docstoc.yml
@@ -67,8 +67,6 @@
 
 - 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'
diff --git a/docs/_documentations/appmetrics.md b/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).
diff --git a/docs/_documentations/mdt-che-createcodewindworkspace.md b/docs/_documentations/mdt-che-createcodewindworkspace.md
@@ -22,4 +22,4 @@ Codewind includes a ready-to-use devfile with its plug-ins.
 
 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)
+Next step: [Setup Tekton Pipelines](mdt-che-tektonpipelines.html)
diff --git a/docs/_documentations/mdt-che-dockerregistries.md b/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>
diff --git a/docs/_documentations/mdt-che-installinfo.md b/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`.
@@ -22,7 +24,8 @@ Install Che to use with Codewind or use Codewind with an existing Che installati
 3. Set up the ClusterRole for Codewind:
 `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:
@@ -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.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`.
diff --git a/docs/_documentations/mdt-che-odo-support.md b/docs/_documentations/mdt-che-odo-support.md
@@ -11,29 +11,35 @@ parent: mdt-che-installinfo
 ---
 
 # OpenShift Do (odo) support in Codewind
+
 The extension to Codewind provides support for [OpenShift Do (odo)](https://github.com/openshift/odo). You can use the extension to efficiently write, build, and deploy components on an OpenShift or OKD cluster.
 
 1. [Extension overview](#overview)
 2. [Setting up extension](#setting-up-extension)
 3. [Current limitation](#current-limitation)
 
 ## Extension overview
+
 - Supports Java, Node.js, Python, and Perl components.
 - Provides OpenShift templates to help you create components with different supported languages.
 - Imports your existing components and continues to develop the components.
 
 ## Setting up extension
 
 ### Prerequisites
+
 - [Install](mdt-che-installinfo.html) Codewind on Che on an OpenShift cluster.
 
 ### Adding roles to support the extension
+
 The extension needs additional roles for accessing OpenShift resources. Use the following commands to clone the [codewind-odo-extension](https://github.com/eclipse/codewind-odo-extension) repository, create the ClusterRole with the required permissions, and bind that ClusterRole to the corresponding Codewind service account.
 
 ### Importing Java image stream to your OpenShift or OKD cluster
+
 In order to create or import Java compoent, you need to import Java image stream to your OpenShift or OKD cluster so that odo can build component image.
 
 ### Adding the roles and importing the Java image stream
+
 1. Log in to your OpenShift or Origin Community Distribution (OKD) cluster and ensure the Codewind workspace is created.
 2. Enter the following commands to go to the correct location, add the roles and import the Java image stream, and perform cleanup:
 ```
@@ -44,6 +50,7 @@ git clone https://github.com/eclipse/codewind-odo-extension &&\
    rm -rf codewind-odo-extension
 ```
 
-## Current limitation
+## Current limitations
+
 - Only supports on Codewind for Eclipse Che with OKD/OpenShift cluster.
 - Does not support debug mode.
diff --git a/docs/_documentations/mdt-che-setupregistries.md b/docs/_documentations/mdt-che-setupregistries.md
@@ -10,7 +10,8 @@ order: 20
 parent: root
 ---
 
-### Adding registries in Che
+# Adding registries in Che
+
 After Che is started and running, add the container registry that will be used with Codewind.
 - On OpenShift or other Kube platforms, you can push your images to any Docker registry, such as Docker Hub, Quay.io, Google Cloud Registry (GCR), and more.
 - On IBM Cloud Private, you can push your image to any Docker registry *except* the internal Docker registry.
diff --git a/docs/_documentations/mdt-che-tektonpipelines.md b/docs/_documentations/mdt-che-tektonpipelines.md
@@ -10,7 +10,8 @@ order: 20
 parent: root
 ---
 
-### Configuring Codewind for Tekton pipelines
+# Configuring Codewind for Tekton pipelines
+
 If you want to use existing Tekton installations with Codewind, from your command line, enter the following commands:
 
 ```
diff --git a/docs/_documentations/mdt-che-usingtheia.md b/docs/_documentations/mdt-che-usingtheia.md
@@ -10,16 +10,18 @@ order: 20
 parent: root
 ---
 
+# Using Codewind from the Che Theia IDE
 
-## Using Codewind from the Che Theia IDE
+## Binding a project:
 
-### Binding a project:
 Go to **View**>**Find Command…**>**Codewind: Add Project**.
 
-### Checking the status of a project
+## Checking the status of a project
+
 Go to **View**>**Find Command…**>**Codewind: App status**.
 
-### Building a project 
+## Building a project 
+
 Go to **View**>**Find Command…**>**Codewind: Build**.
 
 
diff --git a/docs/_documentations/mdt-vsc-getting-started.md b/docs/_documentations/mdt-vsc-getting-started.md
@@ -28,6 +28,3 @@ parent: mdt-vsc-overview
 ![image of Codewind once installed](dist/images/installed.png){:width="800px"}
 
 Next step: [Create your first project](mdt-vsc-firstproject.html)
-
-
-
diff --git a/docs/_documentations/projectview.md b/docs/_documentations/projectview.md
@@ -37,7 +37,7 @@ The page header contains the following information:
 
 At the side of the page is a menu:
 
-![Image of menu](dist/images/projectmenu.png)
+![Image of menu](./images/projectmenu.png)
 
 
 From this menu, you have seven options:
@@ -74,7 +74,7 @@ When one or more log files have changed, an `Updated` notice is displayed. The c
 
 If there are no log files, the dropdown menu will be empty.
 
-![Image of log files](dist/images/viewingmultiplelogfiles.png)
+![Image of log files](./images/viewingmultiplelogfiles.png)
 
 ## Need help?
 If you encounter problems with using the project view, check the [Troubleshooting page](troubleshooting.html#using-the-project-view).
diff --git a/docs/_documentations/remote-overview.md b/docs/_documentations/remote-overview.md
@@ -28,7 +28,7 @@ If you are running in production, the best approach to simplify user administrat
 
 ## Prerequisites
 
-- Install your preferred IDE on your local machine. For more information about installing Eclipse, see [Getting started with Codewind for Eclipse](mdteclipsegettingstarted.html), or for more information about installing VS Code, see [Getting started with Codewind for VS Code](mdt-vsc-getting-started.html).
+- Install your preferred IDE on your local machine. For more information about installing Eclipse, see [Getting started with Codewind for Eclipse](mdt-eclipse-getting-started.html), or for more information about installing VS Code, see [Getting started with Codewind for VS Code](mdt-vsc-getting-started.html).
 - Ensure that you have access to the Codewind CLI `cwctl`. To access the Codewind CLI, open a terminal window and navigate to the following hidden folder: `~/.codewind/<version>`. On Windows, navigate to the following folder: `%SystemDrive%\Users\<username>\.codewind\<version>`.
 - The installer can install Keycloak on its own, Keycloak and Codewind together, or Codewind pointing at an existing Keycloak. If you decide you want to deploy Keycloak on its own first, install it using the `cwctl install remote \` commands described in the following installation procedures and add the `--konly` flag. Then install a Codewind instance that uses Keycloak by adding the `--kurl` flag, which is the ingress of the Keycloak service.
 - Have an active Kubernetes context that points to your cluster. Codewind can run in OpenShift 3.11, OpenShift 4.3, OpenShift in IBM Public Cloud, standalone Kubernetes, and Kubernetes in Docker.
diff --git a/docs/_documentations/remotedeploy-eclipse.md b/docs/_documentations/remotedeploy-eclipse.md
@@ -10,7 +10,7 @@ parent: installoncloud
 order: 2
 ---
 
-## Connecting Eclipse to Remote Codewind
+# Connecting Eclipse to Remote Codewind
 
 1\. Locate the Codewind view in Eclipse and click the cloud icon to launch the new connection wizard:
 
diff --git a/docs/_documentations/remotedeploy-vscode.md b/docs/_documentations/remotedeploy-vscode.md
@@ -10,7 +10,7 @@ parent: installoncloud
 order: 2
 ---
 
-## Connecting VS Code to Remote Codewind
+# Connecting VS Code to Remote Codewind
 
 1\. Locate the Codewind view in VS Code and click the cloud icon to launch the new connection wizard:
 

Original file line number	Diff line number	Diff line change
`@@ -22,4 +22,4 @@ Codewind includes a ready-to-use devfile with its plug-ins.`
`22`	`22`
`23`	`23`	For more sample devfiles, see [`codewind-templates/devfiles/`](https://github.com/kabanero-io/codewind-templates/tree/master/devfiles).
`24`	`24`
`25`		`-Next step: [Setup Tekton Pipelines](mdt-che-tektonpipelines.html)`
	`25`	`+Next step: [Setup Tekton Pipelines](mdt-che-tektonpipelines.html)`