Skip to content

Commit 00b8c25

Browse files
committed
Updated docs
1 parent a28ee65 commit 00b8c25

File tree

2 files changed

+30
-17
lines changed

2 files changed

+30
-17
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
[![Total alerts](https://img.shields.io/lgtm/alerts/g/python-microservices/pyms.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/python-microservices/pyms/alerts/)
1010
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/python-microservices/pyms.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/python-microservices/pyms/context:python)
1111

12+
PyMS, Python MicroService, is a collections of libraries, best practices and recommended ways to build
13+
microservices with Python.
14+
15+
To know how use, install or build a porject see the docs (TODO: add url to readthedocs)
1216

1317
## Installation
1418
```bash
@@ -35,3 +39,20 @@ Encapsulate common rest operations between business services propagating trace h
3539

3640
### pyms/tracer
3741
Create an injector `flask_opentracing.FlaskTracer` to use in our projects
42+
43+
## Documentation
44+
45+
This project use MkDocs
46+
47+
* `mkdocs new [dir-name]` - Create a new project.
48+
* `mkdocs serve` - Start the live-reloading docs server.
49+
* `mkdocs build` - Build the documentation site.
50+
* `mkdocs help` - Print this help message.
51+
52+
### Project layout
53+
54+
mkdocs.yml # The configuration file.
55+
docs/
56+
index.md # The documentation homepage.
57+
... # Other markdown pages, images and other files.
58+

docs/index.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,12 @@
1-
# Welcome to MkDocs
1+
# Welcome to PyMS
22

3-
For full documentation visit [mkdocs.org](https://mkdocs.org).
3+
PyMS, Python MicroService, is a collections of libraries, best practices and recommended ways to build
4+
microservices with Python.
45

56
## 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.
7+
* [Tutorials](structure.md)
8+
* Quick start - minimum project
9+
* Structure of a microservice project
10+
* Swagger and connexion
11+
* Tracing requests
12+
* [Services of Py](structure.md)

0 commit comments

Comments
 (0)