Skip to content

Commit

Permalink
some links to documentated endpoints in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JulienParis committed Jun 9, 2019
1 parent ce66b40 commit b1689a1
Show file tree
Hide file tree
Showing 8 changed files with 90 additions and 3 deletions.
9 changes: 9 additions & 0 deletions docs/_data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 3 additions & 1 deletion docs/_posts/2019-05-01-presentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 :
Expand Down
4 changes: 3 additions & 1 deletion docs/_posts/2019-05-05-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 :

Expand Down
6 changes: 6 additions & 0 deletions docs/_posts/2019-05-08-install-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 26 additions & 0 deletions docs/_posts/2019-06-08-authentication.md
Original file line number Diff line number Diff line change
@@ -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)
19 changes: 19 additions & 0 deletions docs/_posts/2019-06-08-concepts.md
Original file line number Diff line number Diff line change
@@ -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)
24 changes: 24 additions & 0 deletions docs/_posts/2019-06-08-users.md
Original file line number Diff line number Diff line change
@@ -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)
1 change: 0 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# See: https://jekyllrb.com/docs/themes/#overriding-theme-defaults
layout: home
title: TOKTOK auth microservice
classes: wide
sidebar:
nav: "docs"
---
Expand Down

0 comments on commit b1689a1

Please sign in to comment.