diff --git a/docs.old/index.md b/docs.old/index.md deleted file mode 100644 index 6d3f665..0000000 --- a/docs.old/index.md +++ /dev/null @@ -1 +0,0 @@ -WIP \ No newline at end of file diff --git a/docs.old/reviewing.md b/docs.old/reviewing.md deleted file mode 100644 index e5ba0f8..0000000 --- a/docs.old/reviewing.md +++ /dev/null @@ -1,3 +0,0 @@ -# Review process of RXT0112 - -1. Everything has to pass tests unless the merge request is not causing the test failure \ No newline at end of file diff --git a/docs/.gitignore b/docs/.gitignore index 0a3bcf2..b841658 100755 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,4 +1,4 @@ -.* +.jekyll-cache/ !.gitignore !.gitmodules *~ diff --git a/docs/.gitpod.yml b/docs/.gitpod.yml new file mode 100644 index 0000000..a92ddaf --- /dev/null +++ b/docs/.gitpod.yml @@ -0,0 +1,9 @@ +image: + file: gitpod/gitpod.Dockerfile + +ports: + - port: 4000 + onOpen: open-preview + +tasks: + - init: gem install jekyll \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml index bf981dd..60febca 100755 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,6 +1,6 @@ --- -exclude: ['README.markdown'] +exclude: ['README.markdown', 'gitpod'] permalink: ':title' pygments: true safe: false -title: 'Carte' \ No newline at end of file +title: 'Zernit' \ No newline at end of file diff --git a/docs/nav.html b/docs/_includes/nav.html similarity index 100% rename from docs/nav.html rename to docs/_includes/nav.html diff --git a/docs/_posts/2012-12-24-delete-a-thing.md b/docs/_posts/2012-12-24-delete-a-thing.md deleted file mode 100644 index 355b0eb..0000000 --- a/docs/_posts/2012-12-24-delete-a-thing.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -category: Stuff -path: '/stuff/:id' -title: 'Delete a thing' -type: 'DELETE' - -layout: nil ---- - -This method allows the user to post a new thing to his stuff. - -### Request - -* **`:id`** is the id the thing to delete. -* The headers must include a **valid authentication token**. -* **The body is omitted**. - -### Response - -Sends back a collection of things. - -```Status: 200 Deleted``` -```{ - code: 200, - message: 'Your thing (id: 736) was deleted' -}``` - -For errors responses, see the [response status codes documentation](#response-status-codes). \ No newline at end of file diff --git a/docs/_posts/2012-12-25-put-a-thing.md b/docs/_posts/2012-12-25-put-a-thing.md deleted file mode 100755 index 31adbc1..0000000 --- a/docs/_posts/2012-12-25-put-a-thing.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -category: Stuff -path: '/stuff/:id' -title: 'Update a thing' -type: 'PUT' - -layout: nil ---- - -This method allows the user to retrieve his stuff. - -### Request - -* **`:id`** is the id the thing to update. -* The headers must include a **valid authentication token**. -* **The body can't be empty** and must include at least the name attribute, a `string` that will be used as the name of the thing. - -```Authentication: bearer f862f658-ad89-4fcb-995b-7a4c50554ff6``` -```{ - name: 'My new thing' -}``` - -### Response - -Sends back a collection of things. - -```Status: 200 OK``` -```{ - { - id: thing_1, - name: 'My first thing' - }, - { - id: thing_2, - name: 'My second thing' - } -}``` - -For errors responses, see the [response status codes documentation](#response-status-codes). \ No newline at end of file diff --git a/docs/_posts/2012-12-26-post-a-thing.md b/docs/_posts/2012-12-26-post-a-thing.md deleted file mode 100644 index 3ea00e3..0000000 --- a/docs/_posts/2012-12-26-post-a-thing.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -category: Stuff -path: '/stuff' -title: 'Post a thing' -type: 'POST' - -layout: nil ---- - -This method allows users to create a new thing. - -### Request - -* The headers must include a **valid authentication token**. -* **The body can't be empty** and must include at least the name attribute, a `string` that will be used as the name of the thing. - -```Authentication: bearer TOKEN``` -```{ - name: 'My new thing' -}``` - -### Response - -**If succeeds**, returns the created thing. - -```Status: 201 Created``` -```{ - id: new_thing, - name: 'My new thing' -}``` - -For errors responses, see the [response status codes documentation](#response-status-codes). diff --git a/docs/_posts/2012-12-27-get-stuff.md b/docs/_posts/2012-12-27-get-stuff.md deleted file mode 100755 index 3bbf018..0000000 --- a/docs/_posts/2012-12-27-get-stuff.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -category: Stuff -path: '/stuff' -title: 'Get stuff' -type: 'GET' - -layout: nil ---- - -This method allows users to retrieve stuff. - -### Request - -* The headers must include a **valid authentication token**. - -### Response - -Sends back a collection of things. - -```Status: 200 OK``` -```{ - { - id: thing_1, - name: 'My first thing' - }, - { - id: thing_2, - name: 'My second thing' - } -}``` - -For errors responses, see the [response status codes documentation](#response-status-codes). \ No newline at end of file diff --git a/docs/_posts/2012-12-28-authentication.md b/docs/_posts/2012-12-28-authentication.md deleted file mode 100644 index cc681c9..0000000 --- a/docs/_posts/2012-12-28-authentication.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -path: '/login' -title: 'Authenticate' - -layout: nil ---- - -This method allows users to retrieve stuff. - -### Response - -Sends back a collection of things. - -```Authentication: bearer TOKEN``` -```{ - id: thing_2, - name: 'My second thing' -}``` - -For errors responses, see the [response status codes documentation](#response-status-codes). \ No newline at end of file diff --git a/docs/_posts/2012-12-28-response-status-codes.md b/docs/_posts/2012-12-28-response-status-codes.md deleted file mode 100644 index 00747d8..0000000 --- a/docs/_posts/2012-12-28-response-status-codes.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: 'Response status codes' - -layout: nil ---- - -### Success - -Successes differ from errors in that their body may not be a simple response object with a code and a message. The headers however are consistent across all calls: - -* `GET`, `PUT`, `DELETE` returns `200 OK` on success, -* `POST ` returns 201 on success, - -When [retrieving stuff](#get-stuff) for example: - -```Status: 200 OK``` -```{ - { - id: thing_1, - name: 'My first thing' - }, - { - id: thing_2, - name: 'My second thing' - } -}``` - -### Error - -Error responses are simply returning [standard HTTP error codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html) along with some additional information: - -* The error code is sent back as a status header, -* The body includes an object describing both the code and message (for debugging and/or display purposes), - -For a call with an invalid authentication token for example: - -```Status: 401 Access denied``` -```{ - code: 401, - message: 'Access denied: invalid authentication token.' -}``` \ No newline at end of file diff --git a/docs/_posts/2020-02-06-review.md b/docs/_posts/2020-02-06-review.md new file mode 100644 index 0000000..983bd16 --- /dev/null +++ b/docs/_posts/2020-02-06-review.md @@ -0,0 +1,10 @@ +--- +category: Maintainance +title: 'Review process' + +layout: nil +--- + +FIXME-DOCS: preamble + +1. Everything has to pass tests unless the merge request is not causing the test failure \ No newline at end of file diff --git a/docs/gitpod/gitpod.Dockerfile b/docs/gitpod/gitpod.Dockerfile new file mode 100644 index 0000000..d2a4c1e --- /dev/null +++ b/docs/gitpod/gitpod.Dockerfile @@ -0,0 +1,7 @@ +FROM gitpod/workspace-full-vnc + +USER root + +## JEKYLL ## + +RUN apt update && apt install -y ruby ruby-dev firefox