Skip to content

Commit 78f95d0

Browse files
author
Tim Etchells
committed
doc updates
1 parent 0972c1e commit 78f95d0

File tree

3 files changed

+31
-27
lines changed

3 files changed

+31
-27
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
# Contributing
22

3-
Anyone can contribute to the Microclimate Tools for VSCode project, and we welcome your contributions! [Visit us on Slack](https://slack-invite-ibm-cloud-tech.mybluemix.net/) if you have any questions.
3+
Anyone can contribute to the Microclimate Tools for VS Code project, and we welcome your contributions! [Visit us on Slack](https://slack-invite-ibm-cloud-tech.mybluemix.net/) if you have any questions.
44

55
## Raising issues
66

7-
Please raise any bug reports [here](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues). Be sure to search the list to see if your issue has already been raised, and visit our [troubleshooting page](https://microclimate-dev2ops.github.io/mdt-vsc-troubleshooting) too.
7+
If you have identified a problem or have a feature request, we would love to hear about it.
88

9-
A good bug report is one that make it easy for everyone to understand what you were trying to do and what went wrong. Provide as much context as possible so we can try to recreate the issue. Please upload your extension logs with your issue report; instructions for this are also available on the [troubleshooting page](https://microclimate-dev2ops.github.io/mdt-vsc-troubleshooting).
9+
10+
Search the [list of issues](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues) to see if your issue has already been raised. Also visit our [troubleshooting page](https://microclimate-dev2ops.github.io/mdt-vsc-troubleshooting). If you do not see your issue in either of these places, go ahead and [open a new one](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/new).
11+
12+
Please provide context so that we can understand the problem and try to recreate the issue. Instructions for uploading the logs are available on the [troubleshooting page](https://microclimate-dev2ops.github.io/mdt-vsc-troubleshooting).
1013

1114
## Developer Certificate of Origin
1215

13-
If you are contributing changes via a pull request, you must sign-off those changes against the [Developer Certificate of Origin](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/blob/master/DCO1.1.txt).
16+
If you contribute changes with a pull request, sign off those changes against the [Developer Certificate of Origin (DCO)](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/blob/master/DCO1.1.txt).
1417

15-
To indicate you have read and agreed to the DCO, use [`git commit --signoff`](https://git-scm.com/docs/git-commit#git-commit---signoff). It should result in something like the following at the bottom of your commit message:
18+
To indicate that you have read and agreed to the DCO, use [`git commit --signoff`](https://git-scm.com/docs/git-commit#git-commit---signoff), which adds a statement similar to the following at the end of your commit message:
1619

1720
```DCO 1.1 Signed-off-by: Random J Developer <[email protected]>```
File renamed without changes.

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,39 @@
1-
# Microclimate Developer Tools for VSCode
1+
# Microclimate Developer Tools for VS Code
22

33
[![Build Status](https://travis-ci.com/microclimate-dev2ops/microclimate-vscode-tools.svg?token=wpsJvyUkyhtfRa9prmMq&branch=master)](https://travis-ci.com/microclimate-dev2ops/microclimate-vscode-tools)
4+
[![License](https://img.shields.io/badge/License-EPL%201.0-red.svg)](https://opensource.org/licenses/EPL-1.0)
5+
[![Marketplace](https://shields-staging.herokuapp.com/vscode-marketplace/v/IBM.microclimate-tools.svg)](https://marketplace.visualstudio.com/VSCode)
46

57
- **[Marketplace](https://marketplace.visualstudio.com/VSCode)**
68
- **[Documentation](https://microclimate-dev2ops.github.io/mdt-vsc-overview)**
79
- **[Slack](https://slack-invite-ibm-cloud-tech.mybluemix.net/)**
8-
- **[Extension Readme](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/blob/master/dev/README.md)**
10+
- **[Extension README](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/blob/master/dev/README.md)**
11+
12+
You can use Microclimate Developer Tools for Visual Studio Code to develop your [Microclimate](https://microclimate-dev2ops.github.io) projects from within VS Code. Use the tools to access Microclimate features in the comfort of your IDE.
913

1014
## How to install [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-getting-started)
1115

12-
1. Install [VSCode 1.27 or newer](https://code.visualstudio.com/download) and [local Microclimate 18.12 or newer](https://microclimate-dev2ops.github.io/installlocally).
13-
2. Install Microclimate Developer Tools for VSCode from the [VSCode Marketplace](https://marketplace.visualstudio.com/VSCode), or by searching for "Microclimate" in the [VSCode Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
16+
1. Install [VS Code version 1.27 or later](https://code.visualstudio.com/download) and [local Microclimate version 18.12 or later](https://microclimate-dev2ops.github.io/installlocally).
17+
2. Install Microclimate Developer Tools for VS Code from the [VS Code Marketplace](https://marketplace.visualstudio.com/VSCode) or by searching for "Microclimate" in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
1418

15-
For development builds, see the [releases page](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/releases), and follow [these instructions](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) to install.
19+
For development builds, see the [releases page](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/releases). Follow the [Install from a VSIX](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) instructions to install.
1620

1721
## How to use [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-tutorial)
18-
- Open the Microclimate Projects view within the Explorer view group (`Ctrl/Cmd + Shift + E`),
19-
- Right-click to create a default local connection.
20-
- Right-click a project to see the actions available (see below)
21-
- Open the Command Palette (`Ctrl/Cmd + Shift + P`) and type "Microclimate" to see the actions available
22+
- Navigate to the **Explorer** view group and open the **Microclimate** view.
23+
- Right-click the background of the Microclimate view to access the **New connection** commands.
24+
- Right-click a connection or project to access the other commands.
25+
- Open the **Command Palette** keys and type "Microclimate" to see the actions available.
2226

2327
## Features [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-commands-overview)
24-
- View all projects in Microclimate, including their app and build statuses
25-
- Debug Microprofile, Spring, and Node.js Microclimate projects
26-
- View application and build logs in the VSCode *Output* view
27-
- View project information, similar to the Microclimate *Overview* page
28-
- Open your applications in the system browser
29-
- Integrate Microclimate validation errors into the VSCode *Problems* view
30-
- Open a shell session into a Microclimate application container
31-
- Open the *App Monitor* page
32-
- Toggle project auto-build
33-
- Manually initiate project builds
34-
- Scope your VSCode workspace to a Microclimate project or to your *microclimate-workspace*
35-
- Disable, enable, and delete projects
28+
- View all projects in Microclimate, including application and build statuses.
29+
- Debug Microprofile, Spring, and Node.js Microclimate projects.
30+
- View application and build logs in the VS Code **Output** view.
31+
- View project information similar to the information on the Microclimate **Overview** page.
32+
- Integrate Microclimate validation errors into the VS Code **Problems** view.
33+
- Open a shell session into a Microclimate application container.
34+
- Toggle project auto build and manually initiate project builds.
35+
- Scope your VS Code workspace to a Microclimate project or to your `microclimate-workspace`.
36+
- Disable, enable, and delete projects.
3637

3738
## Contributing
38-
We welcome [issues](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues) and contributions from the public! See [CONTRIBUTING.md](https://github.ibm.com/dev-ex/microclimate-vscode/tree/master/CONTRIBUTING.md).
39+
We welcome [issues](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues) and contributions. For more information, see [CONTRIBUTING.md](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/tree/master/CONTRIBUTING.md).

0 commit comments

Comments
 (0)