From b1689a1f6d43ff9b2b64b8ea56b288b86cd1ee54 Mon Sep 17 00:00:00 2001 From: Julien_P Date: Sun, 9 Jun 2019 17:55:35 +0200 Subject: [PATCH] some links to documentated endpoints in docs --- docs/_data/navigation.yml | 9 ++++++++ docs/_posts/2019-05-01-presentation.md | 4 +++- docs/_posts/2019-05-05-installation.md | 4 +++- docs/_posts/2019-05-08-install-docs.md | 6 ++++++ docs/_posts/2019-06-08-authentication.md | 26 ++++++++++++++++++++++++ docs/_posts/2019-06-08-concepts.md | 19 +++++++++++++++++ docs/_posts/2019-06-08-users.md | 24 ++++++++++++++++++++++ docs/index.html | 1 - 8 files changed, 90 insertions(+), 3 deletions(-) create mode 100644 docs/_posts/2019-06-08-authentication.md create mode 100644 docs/_posts/2019-06-08-concepts.md create mode 100644 docs/_posts/2019-06-08-users.md diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index a586f83..17d911b 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -33,6 +33,15 @@ docs: - title: "Install the docs" url: /guide/install-docs + - title: API + children: + - title: "Concepts" + url: /api/concepts + - title: "Authentication" + url: /api/authentication + - title: "Users" + url: /api/users + - title: Developers children: - title: "Stack" diff --git a/docs/_posts/2019-05-01-presentation.md b/docs/_posts/2019-05-01-presentation.md index c47b9d4..5d117ba 100644 --- a/docs/_posts/2019-05-01-presentation.md +++ b/docs/_posts/2019-05-01-presentation.md @@ -50,7 +50,9 @@ Toktok includes "out-the-box" some classic features related to user authenticati - confirm email (optionnal in dev mode): confirm user by sending a confirmation link (protected) in an email - password forgotten by sending a link (protected) in an email with redirection to new password form - reset password from client interface (protected) ... -- Documentation on all API endpoints with Swagger (and some patience from the developers) + +### Documentation + - on all API endpoints with Swagger (and some patience from the developer) ### Features TO DO : - user : diff --git a/docs/_posts/2019-05-05-installation.md b/docs/_posts/2019-05-05-installation.md index d038ae3..0498d80 100644 --- a/docs/_posts/2019-05-05-installation.md +++ b/docs/_posts/2019-05-05-installation.md @@ -50,7 +50,7 @@ You have two different options to run (locally) Toktok on your computer/server : - set up UFW, GIT, NGINX, ... - (optional) [install MongoDB](https://docs.mongodb.com/manual/installation/) (if the Toktok's DB for config is hosted on your own server) - add the github repo - - create and set of secret env variables at the project's folder root based on `example.env.global` and `example.env.mongodb` + - create and set of secret env variables at the project's folder root based on `example.env.global`, `example.env.mailing` and `example.env.mongodb` - lauch docker and run the command : ```sh make up-prod @@ -136,11 +136,13 @@ The environment variables are stored in a couple of files at the root of the pro - `example.env.global` - `example.env.mongodb` +- `example.env.mailing` If you want or need to use Apiviz in production you will have to duplicate those files at the same level with those new names : - `.env.global` - `.env.mongodb` +- `.env.mailing` ... then you will be able to change the environment variable you want and begin to use all of the available arguments like : diff --git a/docs/_posts/2019-05-08-install-docs.md b/docs/_posts/2019-05-08-install-docs.md index 16b9323..8e9e2e1 100644 --- a/docs/_posts/2019-05-08-install-docs.md +++ b/docs/_posts/2019-05-08-install-docs.md @@ -30,6 +30,12 @@ brew install ruby gem install jekyll ``` +- From your repo's root go to the `/docs` folder + +```sh +cd /docs +``` + - Install setup (given the `Gemfile`, `Gemfile.lock` and `_config.yml` files) ```bash diff --git a/docs/_posts/2019-06-08-authentication.md b/docs/_posts/2019-06-08-authentication.md new file mode 100644 index 0000000..d414c95 --- /dev/null +++ b/docs/_posts/2019-06-08-authentication.md @@ -0,0 +1,26 @@ +--- +title : API - authentication +categories: + - api +tags: + - documentation + - configuration + - api +toc: true +toc_label: " contents" +toc_sticky: true +--- + +-------- + +The API for Toktok authentication + +-------- + +## CONFIGURATION COLLECTIONS AND DOCUMENTS + +### DOCUMENTED URLs + +check the following url : + + [`http://localhost:4100/api/auth/documentation`](http://localhost:4100/api/auth/documentation) diff --git a/docs/_posts/2019-06-08-concepts.md b/docs/_posts/2019-06-08-concepts.md new file mode 100644 index 0000000..3ba34e1 --- /dev/null +++ b/docs/_posts/2019-06-08-concepts.md @@ -0,0 +1,19 @@ +--- +title : API - concepts +categories: + - api +tags: + - documentation + - configuration + - api +toc: true +toc_label: " contents" +toc_sticky: true +--- + +-------- + +The API of Toktok backend deals with several distinct concepts : + +- **usr** : users (endpoints and models) +- **auth** : authentication + register (endpoints) diff --git a/docs/_posts/2019-06-08-users.md b/docs/_posts/2019-06-08-users.md new file mode 100644 index 0000000..50ef197 --- /dev/null +++ b/docs/_posts/2019-06-08-users.md @@ -0,0 +1,24 @@ +--- +title : API - users +categories: + - api +tags: + - documentation + - configuration + - api +toc: true +toc_label: " contents" +toc_sticky: true +--- + +-------- + +The API for Toktok users + +-------- + +### DOCUMENTED URLs + +check the following url : + + [`http://localhost:4100/api/usr/documentation`](http://localhost:4100/api/usr/documentation) diff --git a/docs/index.html b/docs/index.html index c30192f..18de155 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,7 +4,6 @@ # See: https://jekyllrb.com/docs/themes/#overriding-theme-defaults layout: home title: TOKTOK auth microservice -classes: wide sidebar: nav: "docs" ---