Skip to content

Commit 87f1b49

Browse files
committed
Updated docs
1 parent a4d6422 commit 87f1b49

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Welcome to PyMS
22

3-
PyMS, Python MicroService, is a collections of libraries, best practices and recommended ways to build
3+
PyMS, Python MicroService, is a collection of libraries, best practices and recommended ways to build
44
microservices with Python.
55

66
## Index:

docs/ms_class.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The class Microservice is the core of all microservices built with PyMS.
44

55

6-
You can create a simple microservices like:
6+
You can create a simple microservice such as:
77

88
```python
99
from flask import jsonify
@@ -29,9 +29,9 @@ And a config file like this config.yml
2929
my-minimal-microservice:
3030
APP_NAME: "Python Microservice"
3131
```
32-
See [Configuration](configuration.md) section to know how create a configuration file.
32+
Check [Configuration](configuration.md) section to know how to create a configuration file.
3333
34-
Each keyworkd in our configuration block, could be accessed in our Microservice object througth the attribute `config`.
34+
Each keyword in our configuration block, can be accessed in our Microservice object through the attribute `config`.
3535

3636
```yaml
3737
# Config.yml
@@ -61,10 +61,10 @@ print(ms.config.multiplevars.config2)
6161

6262

6363
# Looking for Configuration file
64-
By default, Microservice class search a config.yml in the same path. You can set a diferent route or set a json file.
64+
By default, Microservice class search a config.yml in the same path. You can set a different route or set a json file.
6565
To change this path, define a environment variable `CONFIGMAP_FILE`.
6666

67-
This way of search the configuration is useful when you work with Docker and Kubernetes. For example, you can integrate
67+
This way of looking for the configuration is useful when you work with Docker and Kubernetes. For example, you can integrate
6868
a configmap of Kubernetes, with this microservice and a deployment with:
6969

7070
```yaml
@@ -92,4 +92,4 @@ spec:
9292
name: my-microservice-configmap
9393
```
9494

95-
See more examples in [this Github page](https://github.com/python-microservices/pyms/tree/master/examples)
95+
Check more examples in [this Github page](https://github.com/python-microservices/pyms/tree/master/examples)

docs/services.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Services
22

33
Services are libraries, resources and extensions added to the Microservice in the configuration file.
4-
This services are created as attribute of the [Microservice class](ms_class.md) to use in the code.
4+
This services are created as an attribute of the [Microservice class](ms_class.md) to use in the code.
55

6-
To add a service see the [configuration section](configuration.md).
6+
To add a service check the [configuration section](configuration.md).
77

8-
The actual services are:
8+
Current services are:
99

1010
## Swagger / connexion
1111
Extends the Microservice with [Connexion](https://github.com/zalando/connexion)
1212

1313
## Requests
14-
Extends the [requests library](http://docs.python-requests.org/en/master/) with trace headers and parsing JSON objects.
15-
Encapsulate common rest operations between business services propagating trace headers if configured.
14+
Extend the [requests library](http://docs.python-requests.org/en/master/) with trace headers and parsing JSON objects.
15+
Encapsulate common rest operations between business services propagating trace headers if set up.

docs/structure.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
Module to read yaml or json configuration from a dictionary or a path.
55

66
### pyms/flask/app
7-
With the funcion `create_app` initialize the Flask app, register [blueprints](http://flask.pocoo.org/docs/0.12/blueprints/)
8-
and intialize all libraries like Swagger, database, trace system, custom logger format, etc.
7+
With the function `create_app` initialize the Flask app, register [blueprints](http://flask.pocoo.org/docs/0.12/blueprints/)
8+
and initialize all libraries such as Swagger, database, trace system, custom logger format, etc.
99

1010
### pyms/flask/healthcheck
11-
This views is usually used by Kubernetes, Eureka and other systems to check if our application is up and running.
11+
This view is usually used by Kubernetes, Eureka and other systems to check if our application is running.
1212

1313
### pyms/logger
1414
Print logger in JSON format to send to server like Elasticsearch. Inject span traces in logger.
1515

1616
### pyms/tracer
17-
Create an injector `flask_opentracing.FlaskTracer` to use in our projects
17+
Create an injector `flask_opentracing.FlaskTracer` to use in our projects.

0 commit comments

Comments
 (0)