Skip to content
This repository has been archived by the owner on Nov 28, 2022. It is now read-only.

Commit

Permalink
Updating 090 release branch (#400)
Browse files Browse the repository at this point in the history
Signed-off-by: Sarah Ishida <sishida@us.ibm.com>
  • Loading branch information
sishida authored Feb 20, 2020
1 parent 1f49ed4 commit fcd924a
Show file tree
Hide file tree
Showing 17 changed files with 74 additions and 34 deletions.
10 changes: 3 additions & 7 deletions docs/_data/docstoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,9 @@
children:
- title: 'Installing Eclipse Che for Codewind'
url: mdt-che-installinfo.html
- title: 'Configuring Codewind for Eclipse Che'
children:
- title: 'Adding registries in Che'
url: mdt-che-setupregistries.md
- title: 'Creating a Codewind workspace in Che'
url: mdt-che-createcodewindworkspace.md
- title: 'Creating the Codewind workspace'
- title: 'Adding registries in Che'
url: mdt-che-setupregistries.html
- title: 'Creating a Codewind workspace in Che'
url: mdt-che-createcodewindworkspace.html
- title: 'Setup to use Tekton Pipelines'
url: mdt-che-tektonpipelines.html
Expand Down
3 changes: 3 additions & 0 deletions docs/_data/newstoc.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
- title: 'Codewind 0.9.0'
url: news09.html

- title: 'Codewind 0.8.0'
url: news08.html

Expand Down
4 changes: 2 additions & 2 deletions docs/_documentations/gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ type: document
<span class="cs-gettingstarted-mobile-title cw-getting-started-text">Local &nbsp;</span>
</div>
<div class="cw-gettingstarted-card">
<a href="mdt-vsc-getting-started.md"><img alt="VSCode getting started" title="VSCode getting started" src="images/card/vscode.svg"/></a>
<a href="mdt-vsc-getting-started.html"><img alt="VSCode getting started" title="VSCode getting started" src="images/card/vscode.svg"/></a>
<div class="cw-gettingstarted-card-link-container">
<a class="cw-gettingstarted-card-link" href="mdt-vsc-getting-started.html">Codewind for VS Code</a>
</div>
Expand All @@ -44,7 +44,7 @@ type: document
<span class="cs-gettingstarted-mobile-title cw-getting-started-text">Local &nbsp;</span>
</div>
<div class="cw-gettingstarted-card">
<a href="mdt-eclipse-getting-started.md"><img alt="Eclipse che getting started" title="Eclipse che getting started" src="images/card/eclipse.svg"/></a>
<a href="mdt-eclipse-getting-started.html"><img alt="Eclipse che getting started" title="Eclipse che getting started" src="images/card/eclipse.svg"/></a>
<div class="cw-gettingstarted-card-link-container">
<a class="cw-gettingstarted-card-link" href="mdt-eclipse-getting-started.html">Codewind for Eclipse</a>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_documentations/mdt-che-tektonpipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ oc apply -f setup/install_che/codewind-tektonbinding.yaml

For more information about Tekton, see [Getting started with the Tekton Dashboard Webhooks Extension](https://github.com/tektoncd/experimental/blob/master/webhooks-extension/docs/GettingStarted.md).

Next step: [Set Docker Registries](mdt-che-dockerregistries.html)
Next step: [Adding a container registry in Codewind](mdt-che-setupregistries.html)

2 changes: 1 addition & 1 deletion docs/_documentations/mdt-intellij-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Complete the prerequisites and choose to install Codewind on IntelliJ with eithe
10. In the search field, type `codewind`. The `codewind-intellij` plug-in appears. Click **Install**.

### Installing Codewind on IntelliJ from the Eclipse Downloads page
1. Go to the [Eclipse Downloads page](https://download.eclipse.org/codewind/milestone/0.9.0/codewind-intellij-0.9.0.zip) and click `codewind-intellij-0.9.0.zip` to download the file.
1. Download the [codewind-intellij-0.9.0.zip](https://download.eclipse.org/codewind/milestone/0.9.0/codewind-intellij-0.9.0.zip) file to your machine.
2. From IntelliJ, open either **Preferences** or **Settings**. A new window appears.
- On macOS, go to **Main**>**Preferences**.
- On Windows, go to **File**>**Settings**.
Expand Down
4 changes: 0 additions & 4 deletions docs/_documentations/mdt-vsc-commands-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,4 @@ The list of supported project settings are:

[Next: Restart and debug](mdt-vsc-commands-restart-and-debug.html)

[Back to the commands overview](mdt-vsc-commands-overview.html)

[Back to the VS Code tools overview](mdt-vsc-overview.html)

[Troubleshooting](mdt-vsc-troubleshooting.html)
2 changes: 0 additions & 2 deletions docs/_documentations/mdt-vsc-commands-restart-and-debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,4 @@ Next, the launch configuration runs, and the VS Code debugger attaches to your a

[Back to the commands overview](mdt-vsc-commands-overview.html)

[Back to the VS Code tools overview](mdt-vsc-overview.html)

[Troubleshooting](mdt-vsc-troubleshooting.html)
6 changes: 3 additions & 3 deletions docs/_documentations/metrics-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The **Profiling** tab is available only in Node.js projects. This tab pulls info

## Code highlighting for profiling data

Code highlighting for profiling data highlights the most heavily used functions based on profiling data gathered through [load testing](performance). Support for code highlighting is available for Node.js or Java projects that are created through Codewind and then profiled.
Code highlighting for profiling data highlights the most heavily used functions based on profiling data gathered through [load testing](performance.html). Support for code highlighting is available for Node.js or Java projects that are created through Codewind and then profiled.

To enable code hightlighting, you must install the appropriate VS Code extension:
- For Node apps, install the [Codewind Node Profiler](https://marketplace.visualstudio.com/items?itemName=IBM.codewind-node-profiler).
Expand All @@ -72,12 +72,12 @@ Java is supported however if the Metrics Dashboard does not show profiling data,
- 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 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.
1. Open a project created with Codewind and profiled using the [performance testing](performance.html) 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.

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).

If profiling markers do not appear, check to see if your project and load run conform to the [necessary requirements to use profiling](troubleshooting#profiling-markers-do-not-appear).
If profiling markers do not appear, check to see if your project and load run conform to the [necessary requirements to use profiling](troubleshooting.html#profiling-markers-do-not-appear).

## Interpreting the annotation tooltip

Expand Down
10 changes: 5 additions & 5 deletions docs/_documentations/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Then, if you are a software developer, you need to perform many actions as you d

Or, if you are responsible for defining standards for application and runtime environments, such as framework and software levels, you need to implement and maintain your standards across the whole development team, ensuring consistency and reliability.

Built from the ground up, Codewind, an [open source project](https://github.com/eclipse/codewind), helps you to achieve all of the above by extending your Integrated Development Environment (IDE). Container development flow feels like a traditional application flow and [project templates](mdt-vsc-workingwithtemplates.html) can be used across your development teams. Support for rapid iteration of your code is achieved using features including automatic updating of containers with code changes, pre-supplied container-based [project templates](mdt-vsc-workingwithtemplates.html), and a user interface that exposes metrics, logs, and load testing at the click of a button. Your own standardized [project templates](mdt-vsc-workingwithtemplates.html) can be accessed by your developers using their IDE of choice.
Built from the ground up, Codewind, an [open source project](https://github.com/eclipse/codewind), helps you to achieve all of the above by extending your Integrated Development Environment (IDE). Container development flow feels like a traditional application flow and [project templates](workingwithtemplates.html) can be used across your development teams. Support for rapid iteration of your code is achieved using features including automatic updating of containers with code changes, pre-supplied container-based [project templates](workingwithtemplates.html), and a user interface that exposes metrics, logs, and load testing at the click of a button. Your own standardized [project templates](workingwithtemplates.html) can be accessed by your developers using their IDE of choice.

Different development flows are supported, so you can choose whether you want to use a desktop-based or cloud-based IDE, and whether you want to build and run your containers on your desktop or in the cloud.

Expand All @@ -27,9 +27,9 @@ Codewind can be used to build and run Docker-containerized applications on [Kube
### How does Codewind help me develop containerized applications?
Codewind improves your inner loop experience, enabling you to create a microservice quickly, rapidly iterate on changes, and make improvements to performance thanks to the following features:

1. **Access to preconfigured containerized project templates** Codewind provides preconfigured, Docker-containerized [project templates](mdt-vsc-workingwithtemplates.html) covering several languages, including [Node.js](https://nodejs.dev/), [Java](https://www.java.com/), [Python](https://www.python.org/), and [Swift](https://swift.org/), and several frameworks, such as [Express](https://expressjs.com/), [Spring Boot](https://spring.io/projects/spring-boot), and [Open Liberty](https://openliberty.io/). [Quickly create and deploy microservices](https://www.youtube.com/watch?v=zKMggp10gq4&t=12s) in languages and frameworks that you're familiar with. Modify the preconfigured projects to develop your customized microservice.
1. **Access to preconfigured containerized project templates** Codewind provides preconfigured, Docker-containerized [project templates](workingwithtemplates.html) covering several languages, including [Node.js](https://nodejs.dev/), [Java](https://www.java.com/), [Python](https://www.python.org/), and [Swift](https://swift.org/), and several frameworks, such as [Express](https://expressjs.com/), [Spring Boot](https://spring.io/projects/spring-boot), and [Open Liberty](https://openliberty.io/). [Quickly create and deploy microservices](https://www.youtube.com/watch?v=zKMggp10gq4&t=12s) in languages and frameworks that you're familiar with. Modify the preconfigured projects to develop your customized microservice.

2. **Ability to add your own standardized project templates** Create your own [project templates](mdt-vsc-workingwithtemplates.html), and your development teams can access them within their IDE.
2. **Ability to add your own standardized project templates** Create your own [project templates](workingwithtemplates.html), and your development teams can access them within their IDE.

3. **Ability to add your own applications** Access the seamless container development and deployment experience on your IDE that Codewind offers for your current projects.

Expand Down Expand Up @@ -64,9 +64,9 @@ Codewind supports different configurations for developing your containerized app
3. **Use Codewind remotely** Your IDE with the Codewind extension installed is hosted on your desktop, but the building and running of your microservice takes place in your cloud enviroment. Using secure HTTPS connections, you connect to your multiple cloud hosted microservices from the Codewind panel in your desktop-hosted IDE.

### What preconfigured containerized projects does Codewind provide?
Codewind provides preconfigured [project templates](mdt-vsc-workingwithtemplates.html) covering several languages including [Node.js](https://nodejs.dev/), [Java](https://www.java.com/), [Python](https://www.python.org/), and [Swift](https://swift.org/) and several frameworks, such as [Express](https://expressjs.com/), [Spring Boot](https://spring.io/projects/spring-boot), and [Open Liberty](https://openliberty.io/).
Codewind provides preconfigured [project templates](workingwithtemplates.html) covering several languages including [Node.js](https://nodejs.dev/), [Java](https://www.java.com/), [Python](https://www.python.org/), and [Swift](https://swift.org/) and several frameworks, such as [Express](https://expressjs.com/), [Spring Boot](https://spring.io/projects/spring-boot), and [Open Liberty](https://openliberty.io/).

Codewind also supplies [Appsody](https://appsody.dev/) [project templates](mdt-vsc-workingwithtemplates.html) for many languages and frameworks.
Codewind also supplies [Appsody](https://appsody.dev/) [project templates](workingwithtemplates.html) for many languages and frameworks.

### What are the prerequisites for Codewind?
Codewind requires Docker Desktop for Windows or Mac, or Docker Engine and Docker Compose for Linux.
Expand Down
8 changes: 4 additions & 4 deletions docs/_documentations/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,15 +111,15 @@ Issue type: bug/info
Issue link: https://github.com/eclipse/codewind/issues/2239
0.9.0: New
-->
## Cannot find Codewind in Marketplace when attempting to install in Intellij
When attempting to install Codewind in IntelliJ, you cannot locate the Codewind plugin in Marketplace, and if you verify the custom plugin repository link, you get a `Connection failed` error message:
## Cannot find Codewind in Marketplace when attempting to install in IntelliJ
When attempting to install Codewind in IntelliJ, you cannot locate the Codewind plug-in in Marketplace, and if you verify the custom plug-in repository link, you get a `Connection failed` error message:
![intellij install error](dist/images/intellij/custom-plugin-repo-connection-failed-error.png)
This error occurs because the custom plugin repository link contains an additional space.
This error occurs because the custom plug-in repository link contains an additional space.
**Workaround**
Remove the extra space from the custom plugin repository link.
Remove the extra space from the custom plug-in repository link.
***
# Creating a project
Expand Down
4 changes: 2 additions & 2 deletions docs/_documentations/vsc-codechange.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To see this feature in action, make a change to the getting started example.
![](dist/images/vsc-ididthis.png)

The status of the project changes to *stopped* while the project is rebuilt and deployed:

![](dist/images/vsc-buildstopped.png)

After a few moments, the status changes back to *running*:
Expand All @@ -40,4 +40,4 @@ After a few moments, the status changes back to *running*:

![](dist/images/vsc-screenchanged.png)

Next step: [Buiding and deploying in a cloud environment](remoteoverview.html)
Next step: [Buiding and deploying in a cloud environment](remote-overview.html)
2 changes: 1 addition & 1 deletion docs/_news/news05.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ permalink: news05
Thursday 24 October 2019

#### Appsody
- You can now easily import existing Appsody projects into Codewind, or convert projects to use Appsody during import. If you are using the Eclipse IDE, see [Adding existing projects](mdteclipseimportedprojects.html). If you are using VS Code, see [Adding existing projects](mdt-vsc-importedprojects.html).
- You can now easily import existing Appsody projects into Codewind, or convert projects to use Appsody during import. For more information, see [Importing existing projects](importing-existing-projects.html).

#### OpenShift
- Codewind supports the OpenShift project type in Eclipse Che running on OpenShift or OKD. Create and build applications with Codewind and OpenShift. Codewind supports the [ODO extension feature](https://github.com/eclipse/codewind-odo-extension/blob/master/README.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/_news/news06.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The information in the **VS Code** section also applies to Eclipse but with thes
- Codewind 0.6.0 introduces usability improvements for Maven projects after code generation. When you generate a Maven project into the project root folder for the first time, the existing `.pom` file is merged with the one from the generator so that the Maven build completes successfully. In some cases, you might need [manual steps to expose the API endpoints](open-api-tools-for-vscode.html#generating-and-building-client-and-server-stubs-by-using-the-openapi-tools) because the OpenAPI Tools do not override existing project configurations.

#### Templates
- Templates are improved with added details about what a template is. Information is also included for managing templates, working with default templates, and adding your own templates. For Eclipse, see the Eclipse documentation for [Working with templates](mdteclipseworkingwithtemplates.html). For VS Code, see the VS Code documentation for [Working with templates](mdt-vsc-workingwithtemplates.html).
- Templates are improved with added details about what a template is. Information is also included for managing templates, working with default templates, and adding your own templates. For more information, see [Working with templates](workingwithtemplates.html).

#### VS Code output view
- New to VS Code is the Codewind output stream, which logs `cwctl` commands and their output. In addition to providing status on all of your `cwctl` commands, it also helps you to debug unusual problems, especially when you start Codewind. For more information, see [Troubleshooting](mdt-vsc-troubleshooting.html).<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/_news/news07.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can now develop your code locally and securely build and deploy your apps in
- Free up local resources. 👏
- It's secure! 🔐 We use [Keycloak](https://keycloak.org/) to secure the connection between your local editor and remote cloud deployment.

Curious? [Learn more](remoteoverview.html)!
Curious? [Learn more](remote-overview.html)!

#### New Features and Highlights for 0.7.0

Expand Down
Loading

0 comments on commit fcd924a

Please sign in to comment.