Skip to content

Commit

Permalink
update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Bin Cheng committed Nov 18, 2018
2 parents 4d5213d + 951b5d6 commit 72d9eea
Show file tree
Hide file tree
Showing 6 changed files with 6,379 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ check the FIWARE Catalogue entry for
## Content

- [Background](#background)
- [Install](#install)
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
- [Test](#test)
- [Testing](#testing)
- [Quality Assurance](#quality-assurance)
- [More Information](#more-information)
- [License](#license)
Expand Down Expand Up @@ -73,7 +73,7 @@ motivation, functionalities, and benefits of FogFlow.
response time


## Install
## Installation

The instructions to install FogFlow can be found in the
[Installation Guide](https://fogflow.readthedocs.io/en/latest/setup.html)
Expand All @@ -88,7 +88,7 @@ Information about how to use FogFlow can be found in the
APIs and examples of their usage can be found
[here](https://fogflow.readthedocs.io/en/latest/api.html)

## Test
## Testing

For performing a basic end-to-end test, you can follow the detailed instructions [here](https://fogflow.readthedocs.io/en/latest/test.html).

Expand Down
15 changes: 11 additions & 4 deletions doc/en/source/test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,20 @@
Test
*****************************************

Test of Context Management
===================================
Please follow the following steps to deploy the entire FogFlow system on a single Linux machine before your test.

`Set up all FogFlow component on a single machine`_

.. _`Set up all FogFlow component on a single machine`: https://fogflow.readthedocs.io/en/latest/setup.html

Once the FogFlow is up and running, an end-to-end function test can be carried out by JMeter with a provided test plan.
More detailed steps are available here.

`JMeter Test`_

.. _`JMeter Test`: https://github.com/Fiware/test.Functional/tree/master/API.test/data.FogFlow/2.0.0


Test of Service Orchestration
===================================



Expand Down
19 changes: 18 additions & 1 deletion docker/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
Here we
This folder includes all docker-compose files to deploy FogFlow.

- deployment all FogFlow core components on a cloud node; the detailed steps are introduced [here](https://fogflow.readthedocs.io/en/latest/setup.html)

- deployment a FogFlow edge node; the detailed steps are introduced [here](https://fogflow.readthedocs.io/en/latest/edge.html)

the dockerfile files to build FogFlow components are located at the following folders

- discovery: /discovery/Dockerfile

- broker: /broker/Dockerfile

- master: /master/Dockerfile

- worker: /worker/Dockerfile

- designer: /designer/Dockerfile

Loading

0 comments on commit 72d9eea

Please sign in to comment.