Skip to content

Commit a28ee65

Browse files
committed
Added base docs
1 parent e720f7e commit a28ee65

File tree

3 files changed

+46
-0
lines changed

3 files changed

+46
-0
lines changed

docs/index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Welcome to MkDocs
2+
3+
For full documentation visit [mkdocs.org](https://mkdocs.org).
4+
5+
## Index:
6+
* [Structure](structure.md)
7+
8+
9+
10+
* `mkdocs new [dir-name]` - Create a new project.
11+
* `mkdocs serve` - Start the live-reloading docs server.
12+
* `mkdocs build` - Build the documentation site.
13+
* `mkdocs help` - Print this help message.
14+
15+
## Project layout
16+
17+
mkdocs.yml # The configuration file.
18+
docs/
19+
index.md # The documentation homepage.
20+
... # Other markdown pages, images and other files.

docs/structure.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Structure
2+
3+
### pyms/config
4+
Module to read yaml or json configuration from a dictionary or a path.
5+
6+
### 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.
9+
10+
### pyms/flask/healthcheck
11+
This views is usually used by Kubernetes, Eureka and other systems to check if our application is up and running.
12+
13+
### pyms/logger
14+
Print logger in JSON format to send to server like Elasticsearch. Inject span traces in logger.
15+
16+
### pyms/rest_template
17+
Encapsulate common rest operations between business services propagating trace headers if configured.
18+
19+
### pyms/tracer
20+
Create an injector `flask_opentracing.FlaskTracer` to use in our projects

mkdocs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
site_name: My Docs
2+
3+
nav:
4+
- Home: index.md
5+
- Structure: structure.md
6+
theme: readthedocs

0 commit comments

Comments
 (0)