From a52435c97a73a6ee9ca7d4c1c93367167b32df33 Mon Sep 17 00:00:00 2001 From: Boris Baldassari Date: Sat, 24 Nov 2018 12:49:49 +0100 Subject: [PATCH] #3 Fix typos in index + generated doc. --- docs/development/Development-Guidelines.md | 2 +- docs/index.md | 12 +++++++----- .../Running-Scava-in-Eclipse.md | 16 +++++++++------- 3 files changed, 17 insertions(+), 13 deletions(-) rename docs/{development => users}/Running-Scava-in-Eclipse.md (70%) diff --git a/docs/development/Development-Guidelines.md b/docs/development/Development-Guidelines.md index 844d2f4..2a75895 100644 --- a/docs/development/Development-Guidelines.md +++ b/docs/development/Development-Guidelines.md @@ -81,7 +81,7 @@ The repository will contain the code of the high-level components shown in Table | Components | Corresponding folder in repository | Leader | |------------|---------------------------------|-----------| | DevOps Dashboard | | BIT | -| Workflow Diagram Editor | /crossflow| YORK | +| Workflow Diagram Editor | /crossflow | YORK | | Administration Web Application | /administration | SFT | | IDE | /eclipse-based-ide | FEA| | API Gateway | /api-gateway | SFT | diff --git a/docs/index.md b/docs/index.md index b36de33..111443c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,16 +26,18 @@ Useful links: * [Scava metrics](users/Scava-Metrics) lists metrics computed by the various Scava Components. * [Consuming the REST services](users/Consuming-REST-Services) This guideline is dedicated to clients which would like to used SCAVA REST Services.It adress authentication issues +* [Running Scava in Eclipse](users/Running-Scava-in-Eclipse) How to setup and run the Scava Eclipse IDE plugin. * [REST API Documentation](users/REST-API-Documentation) Reference documentation of REST services provided by the Scava platform. * [REST API Generation](users/REST-API-Generation) Tutorial about automatic generation of REST API Scava library using OpenAPI. ## Development -* [Contributing](development/Contributing) Collection of Architectural and Technical guidelines dedicated to Scava developers. -* [Development guidelines](development/Development-Guidelines) Rules and guidelines used for the development of the Scava project. -* [Testing Guidelines](development/Testing-Guidelines) Collection of testing guidelines dedicated to Scava developers. -* [Running Scava in Eclipse](development/Running-Scava-in-Eclipse) How to setup and run the Scava Eclipse IDE plugin. -* [How to develop a metric provider](development/How-To-Develop-Metric-Provider) Want to add a new metric provider? Here are some hints. +* [Contributing](development/Contributing.md) Collection of Architectural and Technical guidelines dedicated to Scava developers. +* [Development guidelines](development/Development-Guidelines.md) Rules and guidelines used for the development of the Scava project. +* [Testing Guidelines](development/Testing-Guidelines.md) Collection of testing guidelines dedicated to Scava developers. +* [Repository-Organisation](development/Repository-Organisation.md) +* [How to develop a metric provider](development/How-To-Develop-Metric-Provider.md) Want to add a new metric provider? Here are some hints. +* [Licensing](development/Licensing.md) Information about licensing used within Scava. ## Architecture diff --git a/docs/development/Running-Scava-in-Eclipse.md b/docs/users/Running-Scava-in-Eclipse.md similarity index 70% rename from docs/development/Running-Scava-in-Eclipse.md rename to docs/users/Running-Scava-in-Eclipse.md index 8ae74bd..f4c1a36 100644 --- a/docs/development/Running-Scava-in-Eclipse.md +++ b/docs/users/Running-Scava-in-Eclipse.md @@ -1,21 +1,23 @@ + +# Running Scava in Eclipse + This page gives **general guidelines for running Ossmeter platform in Eclipse** -The screeshot below will be used as a reference : +The screeshot below will be used as a reference : eclipse Product (Eclipse version used in screenshot : Eclipse Java EE IDE for Web developers Luna 2 (4.4.2) ) -1) We compile with `Ossmeterfromfeature.product` file in `org.ossmeter.platform.osgi` (highlighted above) -2) In the file we put program arguements : `-apiServer`, `-master`, `-slave`. More information on https://github.com/crossminer/crossminer/wiki/Running-the-platform -3) We must validate with the button on corner top right (highlighted above). This will add the required packages. -4) If the required packages are still missing, go to `Run Configurations -> Plug-ins` and click on `Add Required Plugins`. +1. We compile with `Ossmeterfromfeature.product` file in `org.ossmeter.platform.osgi` (highlighted above) +2. In the file we put program arguements : `-apiServer`, `-master`, `-slave`. More information on https://github.com/crossminer/crossminer/wiki/Running-the-platform +3. We must validate with the button on corner top right (highlighted above). This will add the required packages. +4. If the required packages are still missing, go to `Run Configurations -> Plug-ins` and click on `Add Required Plugins`. Eclipse2 -5) You could also check the `general information`, if its the same (as in the screenshot below). +5. You could also check the `general information`, if its the same (as in the screenshot below). Eclipse Overview These were some of the things for running the platform. If there is any issue still, do not hesitate to contact us. -