Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Turn docs done by @agichim into official docs #49

Merged
merged 9 commits into from
Dec 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@ _site
.sass-cache
.jekyll-metadata
/.debug.log
.dendron.port
.dendron.ws
debug.log
File renamed without changes.
42 changes: 42 additions & 0 deletions _backup/en/admin/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
lang: en
title: Admin's guide
ref: admin-home
has_children: true
nav_order: 7
---

# Admin's guide

Welcome to the administrator's guide for the CoopCycle platform.

Our software is a complete logistics and e-commerce system allowing the delivery of a product from A to B. Our platform is dedicated to bicycle delivery and its license is designed to reserve the use for worker owned co-operatives only.

The platform is composed of two components:

## Logistics
Pickup and dropoff management organised into a task system (two tasks form a delivery) allowing the following user actions:

- The **administrator**:
- can assign tasks or task lists to a courier.
- can track the position of a courier in real time from the dispatch (dashboard) screen; assigning tasks can be done the day before or in real time.
- can manage pricing for stores (by weight, distance, zone, type of bike).

- The **courier**:
- will receive the tasks on their smartphone (iOS and Android).
- can mark a task as completed or failed and can add a comment.

- The **customer**:
- can place an order on the platform and pay (price calculation is automated and secured through Stripe).

## E-commerce
Management of restaurants and shops, allowing the following user actions:

- The **customer**:
- can place an order via the platform (website) or via the smartphone application.
- can place an order from a restaurant, by inputing their address and selecting a delivery time.

- The **business**:
- receives the order in real time, they can then accept or reject it.
- can mark the order as ready, in this case the courier is notified.
- can manage their menu online.
File renamed without changes.
42 changes: 42 additions & 0 deletions _backup/en/admin/orders.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Orders
lang: en
ref: admin-orders
parent: Admin's guide
nav_order: 3
---

# Orders

Orders page displays the orders engaged by clients on the platform. It enables to manage restaurant's orders.

There are two types of orders :

- Foodtech orders, engaged by end customers
- Orders of deliveries, engaged with the integrated form for instance.

An order can have these following status :

- New, the order was not accepted by the restaurant yet
- Accepted, the order is in preparation
- Refused, the order has been refused
- Ready, the order is waiting a bike messenger or its delivery is underway
- Done, the order was delivered
- Cancelled, the order was cancelled by the client or the restaurant

## List of orders

![Commandes](/assets/images/orders_fr.png)

The list of orders displays orders which are underway on the platform. You can display the cancelled orders by ticking the option : "Display cancelled orders”.

The administrator can cancel an order by clicking on the button `Cancel` d’une commande. Displayed informations are :

- id, order's number
- The type of order
- Customer who engaged the order
- The order's statut
- Total amount charged for the customer
- The associated bill, that you can download in pdf format
- Date of creation
- The `Cancel` button for an order
38 changes: 38 additions & 0 deletions _backup/en/admin/stores.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Stores
lang: en
ref: admin-stores
parent: Admin's guide
nav_order: 4
---

In CoopCycle's « vocabulary », a **Store** represents a B2B customer, i.e. a professional merchant to whom the cooperative offers its delivery services.

Basically, a **Store** is a container for deliveries.
Users can be attached to a **Store**, and once attached, they can use the web interface to order deliveries using a form.
The deliveries ordered this way land directly in the dispatch.

## Store Settings

The settings will change the behavior of the form to order a delivery.

![Store Settings](/assets/images/store_settings_en.png)

### Pricing

This allows to decide how the prices for this **Store** will be calculated.
You can choose among the **Pricing Rules** that you have configured previously.

[Learn more about defining Pricing Rules](/en/admin/actions/pricing.html).

Heads up
{: .label }

If you want the price to be displayed to the user, you need to check the « Create orders » checkbox.

### Time Slot

This allows to decide which time slots the user will be able to select.

[Learn more about defining Time Slots](/en/admin/actions/time-slots.html).

File renamed without changes.
48 changes: 48 additions & 0 deletions _backup/en/admin/users.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Users
lang: en
ref: admin-users
parent: Admin's guide
nav_order: 6
---

# Management of users

The list of administrators is available in the page `Users`. This list describes accounts which are inscribed on the platform and their associated informations. It also enables to add/create a new user.

## User profil

An user account is associated to the following informations :

- User name
- First name
- Last name
- Telephone number
- Password
- Email adress

It is possible to activate/desactivate users. A desactivated user is disconnected and can't access the platform anymore.

## Roles

Every user can have one or several roles. Every role gives access to some platform features.

| Role | Customer | Bike messenger | Restaurant | Shop | Admin |
| ------------------------------- |:------:|:---------:|:----------:| :----------:| :----------:|
| To edit his/her own personal informations | ✔ | ✔ | ✔ | ✔ | ✔ |
| To create and modify restaurants | | | ✔ | | ✔ |
| Mannage orders | | | ✔ | | ✔ |
| To edit a receipt | | | ✔ | | ✔ |
| To create and modify menus | | | ✔ | | ✔ |
| To create shops | | | | | ✔ |
| To modify shops | | | | ✔ | ✔ |
| To create a delivery | | | | ✔ | ✔ |
| To manage deliveries | | ✔ | | | ✔ |
| To access CoopCycle API | | ✔ | ✔ | | ✔ |
| To edit roles for users | | | | | ✔ |
| To edit contracts and tarifications | | | | | ✔ |


## Assignation of a shop/restaurant

On the informations about an user which has the `Restaurant` role, you can assignate him/her (To make him/her owner) a shop that you have previously created. It also works for an user who has a `shop-owner` role.
File renamed without changes.
7 changes: 7 additions & 0 deletions _backup/en/app/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
lang: en
title: App
ref: app-home
has_children: true
nav_order: 3
---
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions _backup/en/courier/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
lang: en
title: Courier's guide
ref: courier-home
has_children: true
nav_order: 4
---

# Courier's guide

Welcome to the courier's guide for the CoopCycle platform.

## Courier's guide on the platform

## Courier's guide on the app
68 changes: 68 additions & 0 deletions _backup/en/developer/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: Using the CoopCycle API
lang: en
ref: dev-api
parent: Developer
nav_order: 1
---

# Using the CoopCycle API

[Open API / Swagger documentation](https://demo.coopcycle.org/api/docs)

## Authentication

Most of the API endpoints require authentication, and also authorization.
<br>
Authentication is implemented by sending a [JSON Web Token](https://jwt.io/introduction/) via HTTP headers.

```
Authorization: Bearer <token>
```

### Authenticating as a web application

If you are creating a web application that does not need to act on behalf of a user, you need to use the [OAuth client credentials](https://oauth.net/2/grant-types/client-credentials/) flow to obtain an access token.

**Obtaining API credentials**

To create access tokens, you will need API credentials (an API key and an API secret).
<br>
Ask the platform administrators to create a API application and send you the API credentials.

**Using the credentials to obtain an access token**

The first step to make authenticated requests is to obtain an **access token**.
<br>
To obtain an access token, you first need to make a request to the `/oauth2/token` endpoint,
with your API credentials encoded as Base64.

Here is an example to encode your API credentials using PHP:

```
php -r 'echo base64_encode("<api_key>:<api_secret>"), PHP_EOL;'
```

Here is an example request to the `/oauth2/token` endpoint using cURL:

```
curl -X POST -d 'grant_type=client_credentials&scope=tasks+deliveries' -H 'Authorization: Basic <base64_credentials>' https://acme.coopcycle.org/oauth2/token
```

The response should look like this:

```
{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "<access_token>"
}
```

**Using the access token to make authenticated requests**

You can now use the access token to make authenticated requests to the API

```
curl -X POST -d '{ ... }' -H 'Content-Type: application/ld+json' -H 'Authorization: Bearer <access_token>' https://acme.coopcycle.org/api/deliveries
```
File renamed without changes.
12 changes: 12 additions & 0 deletions _backup/en/developer/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
lang: en
title: Developer
ref: dev-home
has_children: true
nav_order: 3
---

# Developer's guide

Welcome to the developer's guide for CoopCycle platform.
{: .fs-6 }
File renamed without changes.
19 changes: 19 additions & 0 deletions _backup/en/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
layout: home
lang: en
title: Home
ref: homepage
nav_order: 1
---

**Welcome!**

This documentation is hosted on [GitHub Pages](https://pages.github.com/).

You can use the "Edit this page" button to be redirected to the GitHub online editor.

For a guide on how to edit the docs see [Edit Docs] or go to Tutorials → Editing Docs.

---

Go here to get started.
File renamed without changes.
File renamed without changes.
File renamed without changes.
13 changes: 13 additions & 0 deletions _backup/en/restaurant/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
lang: en
title: Restaurant's guide
ref: restaurant-home
has_children: true
nav_order: 8
---

# Restaurant's guide (overview)

## Restaurant's guide on the platform

## Restaurant's guide on the app
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 10 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ plugins:
- jekyll-seo-tag
- jekyll-sitemap
- jekyll-redirect-from
- jekyll-relative-links

# Color scheme currently only supports "dark" or nil (default)
color_scheme: nil
Expand All @@ -53,4 +54,13 @@ exclude:
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/
- _backup
- _translations/
- vendor

gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub."
gh_edit_repository: "https://github.com/coopcycle/coopcycle-docs" # the github URL for your repo
gh_edit_branch: "master" # the branch that your docs is served from
# gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately
1 change: 0 additions & 1 deletion _dendron/.dendron.port

This file was deleted.

1 change: 0 additions & 1 deletion _dendron/.dendron.ws

This file was deleted.

6 changes: 0 additions & 6 deletions _dendron/debug.log

This file was deleted.

7 changes: 7 additions & 0 deletions _includes/head_custom.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!-- CSS -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-TX8t27EcRE3e/ihU7zmQxVncDAy5uIKz4rEkgIXeMed4M0jlfIDPvg6uqKI2xXr2" crossorigin="anonymous">
<!-- jQuery and JS bundle w/ Popper.js -->
<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-ho+j7jyWK8fNQe+A12Hb8AhRq26LrZ/JpcUGGOn+Y7RsweNrtN/tE3MoK7ZeZDyx" crossorigin="anonymous"></script>
<!-- Font Awesome -->
<script src="https://kit.fontawesome.com/489c6dd9c4.js" crossorigin="anonymous"></script>
Loading