Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Minor improvements of Foxx in a nutshell documentation

This commit is contained in:
Michael Hackstein 2015-03-10 14:00:38 +01:00
parent ba266d4a0f
commit fbb5d02b2c
2 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/Books/Users/Foxx/Nutshell/README.mdpp
View File

@ -30,7 +30,7 @@ Start the interface from <a href="http://localhost:8529" target="_blank">http://
!SECTION Create a new application
1. Click on `Add Application` / `New App`.
2. You will be offered a dialog to fill in some information about your application.
3.For this tutorial we will use the following information:
3. For this tutorial we will use the following information:
* <strong>Author:</strong> ArangoDB
* <strong>Name:</strong> firstApp
* <strong>Description:</strong> This is my first Foxx app
@ -47,7 +47,7 @@ Start the interface from <a href="http://localhost:8529" target="_blank">http://
<a id="interactive-doc" />
!SUBSECTION Interactive documentation
Now you should see your new application in the list of installed applications.
Click on it, leading you to the details page.
Clicking on it will lead you to the details page.
This page provides the meta information about the application entered in the generating dialog.
You can modify this information in the applications manifest file.
Additionally, the interactive [swagger-documentation]("http://www.swagger.io/") could be used to test the app.
@ -70,7 +70,7 @@ In order to develop your Foxx you now have two options. If you do not have acces
![Download and Upgrade the Application](foxx_download_upgrade.png)
2. Use Foxx development mode.
1. Use Foxx development mode.
* Active the development mode by clicking on `Set Dev`.
* The Web Interface will print the folder containing the sources of your Application.
* Open this folder to modify the files.

21
Documentation/Books/Users/Foxx/README.mdpp
View File

@ -1,19 +1,18 @@
!CHAPTER Foxx
In the recent movements of software development many companies of all sizes talk about
moving away from large monolithic applications and switch over to a microservice based
software architecture.
Because it yields many benefits in terms of scaling and zero-downtime.
moving away from large monolithic applications and switch over to a microservice based software architecture.
Because microservices yield many benefits in terms of scaling and zero-downtime.
During the design of foxx we followed the concepts and ideas of microservices.
During the design of Foxx we followed the concepts and ideas of microservices.
Our baseline is the definition by Martin Fowler and James Lewis given in their [microservice article](http://martinfowler.com/articles/microservices.html).
The following table lists a mapping of microservice concepts and how they can be realized within foxx:
The following table lists a mapping of microservice concepts and how they can be realized within Foxx:
<table>
<thead>
<tr>
<th>microservice</th>
<th>foxx</th>
<th>Foxx</th>
<th>description</th>
</tr>
</thead>
@ -111,14 +110,14 @@ The following table lists a mapping of microservice concepts and how they can be
</tbody>
</table>
As you can see most concepts of microservices are natively available in foxx plus several additions that easy your development
As you can see most concepts of microservices are natively available in Foxx plus several additions that easy your development
process.
That is why we like to call foxx a "microservice framework": It allows you to write and deploy data-centric microservices
That is why we like to call Foxx a "microservice framework": It allows you to write and deploy data-centric microservices
on top of ArangoDB.
If this short introduction has piqued your interest you can find more details in the sections below.
We recommend to start with Foxx in a nutshell which gives a really quick introduction in how to
create and use your first foxx.
create and use your first Foxx.
All other sections will give very detailed informations about the features available and a peak behind the curtains.
!SECTION Foxx in a nutshell
@ -181,5 +180,5 @@ It will also explain how to move your application from a single server to an unl
This chapter will present the more advanced capabilities of Foxx.
It requires that you know the details presented in the chapters before.
Here you will learn about foxx feature exports and imports to implement abstract APIs for reuse in several Apps.
Furthermore you will learn about background and periodical tasks in foxx applications.
Here you will learn about Foxx feature exports and imports to implement abstract APIs for reuse in several Apps.
Furthermore you will learn about background and periodical tasks in Foxx applications.