Merge pull request #27 from eclipse/development

Development

CONTRIBUTING

@@ -0,0 +1,46 @@
+# Contributing to Eclipse Che4z
+
+Thank you for your interest in this project.
+
+## Project description
+
+Eclipse Che is an open-source, next-generation development platform, leveraging
+container technology which offers a more streamlined onboarding process for new
+developers to ensure they have the tools they need. Using stacks, Eclipse Che
+creates a workspace which brings the necessary technology to the task at hand.
+More information about Che can be found here.
+
+* https://projects.eclipse.org/projects/ecd.che.che4z
+
+## Developer resources
+
+Information regarding source code management, builds, coding standards, and
+more:
+
+* https://projects.eclipse.org/projects/ecd.che.che4z/developer
+
+The project maintains the following source code repositories:
+
+* https://github.com/eclipse/che-che4z-explorer-for-endevor
+
+## Eclipse Contributor Agreement
+
+Before your contribution can be accepted by the project, team contributors must
+electronically sign the Eclipse Contributor Agreement (ECA).
+
+* http://www.eclipse.org/legal/ECA.php
+
+Commits provided by non-committers must have a "Signed-off-by" field in
+the footer indicating that the author is aware of the terms by which the
+contribution has been provided to the project. The non-committer must
+additionally have an Eclipse Foundation account with a signed Eclipse
+Contributor Agreement (ECA) on file.
+
+For more information, see the Eclipse Committer Handbook:
+https://www.eclipse.org/projects/handbook/#resources-commit
+
+## Contact
+
+Contact the project developers via the project's "dev" list:
+
+* https://accounts.eclipse.org/mailing-list/che4z-dev

Readme.md

@@ -34,40 +34,41 @@ Prior to using Explorer for Endevor, ensure that you meet the following prerequi
 
 - Access to Mainframe
 - Access to CA Endevor® SCM
-- Installed and configured CA Endevor® SCM Web Services.
-- Latest maintenance and updates applied.
-    - Check [here](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/devops/ca-endevor-software-change-manager/18-1.html) for more information.
-- **Optional:**
-    - If installing in Eclipse Che IDE:
-        - Eclipse Che 7.3 on Kubernetes
+
+- CA Endevor® SCM version 18.0.12 or higher with the following PTFs applied:
+   - (if using version 18.0.x) PTFs SO09580, SO09581, SO10013 and SO11268
+   - (if using version 18.1.x) PTF SO11272
+   - (Optional) For use of Web Services with STC Pooling, ensure that you also have PTFs SO03928 and SO03929.
+- CA Endevor® SCM Web Services installed and configured. For more information, see the [CA Endevor® SCM documentation](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/devops/ca-endevor-software-change-manager/18-1/installing/how-to-enable-web-services/configure-ca-endevor-scm-for-web-services.html)
 
 ## **Installing**
 
 Explorer for Endevor is included with Eclipse Che version 7.6.0 and above. Check [here](https://www.eclipse.org/che/docs/che-7/introduction-to-eclipse-che/) for more information.
 
-If using Eclipse Che version 7.3 on Kubernetes, follow the Installing Che section [here](https://github.com/eclipse/che-che4z).
 
 ## **User Guide**
 
-You must first create a host in Explorer for Endevor to enable it to access the repository you want to explore.
+Create a Host in Explorer for Endevor to enable it to access the repository you want to explore.
 
 ### **Create a Host**
 
-Create a Host in Explorer for Endevor to specify the data source you want to work with. This will allow you to view and explore the selected Endevor repositories.
+Create a Host in Explorer for Endevor to specify the data source you want to work with. This allows you to view and explore the selected Endevor repositories.
+
 
 ![](https://github.com/eclipse/che-che4z-explorer-for-endevor/blob/v0.9.1/create_host.gif)
 
 **Procedure:**
 
 1. Open the Explorer for Endevor extension.
 2. Click the plus icon or *New connection*.
-
-   You will be prompted to enter an Endevor repository URL in the format 'http(s)://url:port', for example 'http(s)://myhost01:9090' then press 'Enter' to confirm or 'Escape' to cancel.
-3. Select a CA Endevor SCM configuration from the drop-down list.
+   A prompt opens.
+3. Enter an Endevor repository URL in the format 'http(s)://url:port', for example 'http(s)://myhost01:9090' then press 'Enter' to confirm or 'Escape' to cancel.
+4. Select a CA Endevor SCM configuration from the drop-down list.
 
 You have successfully created a new Host connected to a repository, and the Host is listed under Explorer for Endevor in the interface.
-- Change the name of the connection by clicking the pencil icon next to the connection name. Names must be unique as duplicate names are not permitted.
-- Filters can be created in the connection without being logged in, however you will be prompted to enter your credentials before any data is displayed.
+- Change the name of the connection by clicking the pencil icon next to the connection name. Ensure that the connection name is unique.
+- Filters can be created in the connection without being logged in, but no data is displayed until you log in.
+
 
 ### **Create a Filter**
 
@@ -101,15 +102,17 @@ Creating a manual filter is a quick way to narrow down your search to only relev
 
         - env/stgnum/sys/subsys/type/element
 
-    If the parameters (with a maximum of two parameters as * wildcards) are correctly entered, the filter will appear under the expanded Filter section in the Explorer for Endevor tab.
+    If the parameters (with a maximum of two parameters as * wildcards) are correctly entered, the filter appears under the expanded Filter section in the Explorer for Endevor tab.
+
 
 #### **Create a Filter in Map View:**
 
 Map View allows you to create custom filters, without necessarily knowing the parameters in advance or if you have limited or no prior knowledge of Endevor.
 
 **Follow these steps:**
 1. Open Map View in Explorer for Endevor for your selected Host
-2. Navigate the view as required, selecting your desired options as you navigate through the different parameters in hierarchical order.
+2. Select your desired options as you navigate through the different parameters in hierarchical order.
+
 3. Select an entry at the **Type** level, and click the plus icon.
 
     The path that you followed appears highlighted at the top of your screen, displaying the following dialog:
@@ -150,7 +153,8 @@ The Browse Element action displays the entire contents of the Element, including
 
 ## **Configuration and Usage Tips**
 
-- Delete any filters when no longer required. Filters are saved automatically and so the list can become hard to manage.
+- Delete any filters when no longer required. Filters are saved automatically and so the list might become hard to manage.
+
 - Restrict filters to a maximum of two wildcard entries to avoid heavy resource usage. If you have any requirements or dependencies, add a section describing those and how to install and configure them.
 
 ## **Features**:
@@ -195,7 +199,8 @@ For more information, please visit our [documentation](http://techdocs.broadcom.
 ---------------------------------------------------------------
 ### **Technical Assistance and Support for CA Explorer for Endevor**
 
-CA Explorer for Endevor extension is made available to customers on Visual Studio’s Code Marketplace in accordance with the terms and conditions contained in the provided End-User License Agreement (EULA).
+The Explorer for Endevor extension is made available to customers on the Visual Studio Code Marketplace in accordance with the terms and conditions contained in the provided End-User License Agreement (EULA).
+
 
 If you are on active support for CA Endevor, technical assistance and support is provided to Broadcom’s CA Endevor customers in accordance with the terms, guidelines, details and parameters located within Broadcom’s “Working with Support” guide located at: