Update everything before the release.

I proofread all the pages and updated was needed to be updated.
This commit is contained in:
Ana Gelez 2019-12-16 21:59:10 +01:00
parent 2f17354b87
commit 4ad5745484
8 changed files with 157 additions and 35 deletions

View file

@ -5,6 +5,8 @@ summary: 'plm is a little CLI tool that can help you to manage your instance fro
command line if you are admin of an instance.'
---
You can see these help messages with `plm --help` or `plm COMMAND --help` (where `COMMAND` is the specific subcommand you are interested in).
If any required argument is ommitted, you will be asked to input manually.
## `plm instance`
@ -55,13 +57,28 @@ plm users new --admin -n 'kate' -N 'Kate' --bio "I'm Kate." --email 'kate@plu.me
- `--password`, `-p`: the password of the user. You probably want to use this option in shell scipts only, since if you don't specify it, the prompt won't show your password.
- `--admin`, `-a`: makes the user an admin of the instance. Optional, off by default.
### `plm users reset-password`
Resets user password.
**Example:**
```bash
plm users reset-password -u 'alice' -p 'top_secret'
```
**Arguments:**
- `--user`, `-p`: the username of the person which will have their password reset (no `@` before, not the display name).
- `--password`, `-p`: the new password of the user. You probably want to use this option in shell scipts only, since if you don't specify it, the prompt won't show your password.
## `plm search`
Manage full text search index.
Manage search index.
### `plm search init`
Initialize the search index.
Initialize Plume's internal search engine.
**Example:**
@ -71,12 +88,11 @@ plm search init -p Plume
**Arguments:**
- `--path`, `-n`: path to plume working directory.
- `--force`, `-f`: override any already existing search index.
- `--path`, `-p`: path to Plume's working directory.
### `plm search refill`
Refill the search index.
Regenerates the search index.
**Example:**
@ -86,7 +102,7 @@ plm search refill -p Plume
**Arguments:**
- `--path`, `-n`: path to plume working directory.
- `--path`, `-p`: path to Plume's working directory.
### `plm search unlock`
@ -101,7 +117,7 @@ plm search unlock -p Plume
**Arguments:**
- `--path`, `-n`: path to plume working directory.
- `--path`, `-n`: path to Plume's working directory.
## `plm migration`
@ -119,7 +135,7 @@ plm migration run -p Plume
**Arguments:**
- `--path`, `-p`: path to Plume working directory.
- `--path`, `-p`: path to Plume's working directory.
### `plm migration redo`
@ -133,4 +149,4 @@ plm migration redo -p Plume
**Arguments:**
- `--path`, `-p`: path to Plume working directory.
- `--path`, `-p`: path to Plume's working directory.

View file

@ -25,40 +25,145 @@ paths:
The post exists, but you don't have the rights to fetch it (it is probably a private draft)
'404':
The post was not found
delete:
Deletes the post corresponding to this ID.
/posts/:
get:
description:
List posts.
parameters:
- name: title
in: path
description: Only list article with this specific title
required: false
schema:
type: string
- name: subtitle
in: path
description: Only list article with this specific subtitle
required: false
schema:
type: string
- name: content
in: path
description: Only list article with this specific content (in HTML)
required: false
schema:
type: string
post:
description:
Creates a new post.
requestBody:
content:
'application/json':
schema:
properties:
title:
description: The title of the new article.
type: string
subtitle:
description: The subtitle of the new article.
type: string
source:
description: The markdown source of the new article.
type: string
blog_id:
description: The ID of the blog in which to publish the new article.
type: integer
published:
description: false if this article is a draft, true if it is published.
type: bool
creation_date:
description: The publication of this article. Past dates will work, but not futures ones. Defaults to the current date. The expected format is %Y-%m-%d.
type: string
license:
description: The license of the article. Omit this field to use the default one for this instance. Leave it empty to reserve all rights.
type: string
tags:
description: The tags for the new article.
type: array
cover_id:
description: The ID of the cover image.
type: integer
required:
- title
- description
- author
definitions:
App:
type: "object"
type: object
properties:
name:
type: "string"
description: The name of the app.
type: string
example: "My app"
website:
type: "string"
description: The website of the app.
type: string
example: "https://my.app"
client_id:
type: "string"
example: "My app"
description: A unique identifier for the app.
type: string
example: "abcdef0123456789"
client_secret:
type: "string"
example: "My app"
description: The secret token associated to this app. It will be used to get individual authentication tokens for each user of the app.
type: string
example: "abcdef0123456789"
Post:
type: "object"
type: object
properties:
title:
type: "string"
example: "Hello, world!"
id:
type: "integer"
format: "int64"
example: 42
description: The internal ID of the post.
type: integer
example: 3
title:
description: The title of the post.
type: string
example: "Hello, world!"
subtitle:
type: "string"
description: The subtitle of the post.
type: string
example: "My first post."
content:
type: "string"
format: "<p>This is my first post. Thanks for reading.</p>"
description: The content of the post, rendered as HTML.
type: string
format: "<p>This is my first <b>post</b>. Thanks for reading.</p>"
source:
description: The markdown source of the post.
type: string
example: "This is my first **post**. Thanks for reading."
authors:
description: The FQNs of the authors of this post.
type: array
example:
- "alice"
- "bob@plume.one"
blog_id:
description: The ID of the blog in which this article was published.
type: integer
example: 12
published:
description: true if the article is published, false if it is still a draft.
type: bool
example: true
creation_date:
description: The publication date.
type: string
example: "2019-12-16"
license:
description: The license of this post.
type: string
example: "CC-BY-SA"
tags:
description: The tags of this post.
type: array
example:
- Plume
- REST
- API
- JSON
cover_id:
description: The ID of the media used as cover for this article.
type: integer
example: 42

View file

@ -2,7 +2,7 @@
title: Installing Rust & Cargo
---
TODO: instructions to choose the correct nightly directly?
<!-- TODO: instructions to choose the correct nightly directly? -->
Rust and Cargo use a special installer called *RustUp* that let's you manage
various versions of these two programs in parallel.
@ -41,4 +41,4 @@ You can check that everything is correctly installed with `rustc --version` and
We can now compile Plume's source code.
<a class="action" href="/installation/with/source-code">Compiling Plume</a>
<a class="action" href="/installation/with/source-code">Compiling Plume</a>

View file

@ -42,9 +42,9 @@ docker-compose up -d postgres
docker-compose run --rm plume plm migration run
# Setup your instance
docker-compose run --rm plume plm search init
docker-compose run --rm plume plm instance new -d 'domain.name' -n 'instance name' -l 'default licence'
docker-compose run --rm plume plm users new -n 'admin' -N 'name' -b 'bio' -e 'admin@domain.name' -p 'pass' --admin
docker-compose run --rm plume plm search init
# Launch your instance for good
docker-compose up -d

View file

@ -9,7 +9,7 @@ You will need to have `wget` installed for this method to work.
To download and install the latest release, first define the following variables in your shell:
- `PLUME_VERSION`: the Plume version to install. The latest is `0.3.0-alpha-2`.
- `PLUME_VERSION`: the Plume version to install. The latest is `0.4.0-alpha-4`.
- `PLUME_DB`: the database backend to use. Either `postgres` or `sqlite`.
Then run these commands:

View file

@ -19,9 +19,11 @@ followed by `sudo snap set plume enabled=true`.
This sets the base snap configuration; now you must configure your instance:
`sudo plume.plm instance new -d 'domain.name' -n 'instance name' -l 'default licence'`
`sudo plume.plm users new -n 'admin' -N 'name' -b 'bio' -e 'admin@domain.name' -p 'pass' --admin`
`sudo plume.plm search init`
```bash
sudo plume.plm search init
sudo plume.plm instance new -d 'domain.name' -n 'instance name' -l 'default licence'
sudo plume.plm users new -n 'admin' -N 'name' -b 'bio' -e 'admin@domain.name' -p 'pass' --admin
```
And that's it! You can now setup a reverse-proxy to access Plume from other machines
than your server (which is probably what you want 😁).

View file

@ -70,5 +70,3 @@ Skills:
You can either [do it by yourself](https://github.com/Plume-org/docs/edit/master/source/organization/contributors.html.md)
if you have a GitHub account, or give Ana all the required informations and she will add you (see above for contact information).
Please keep the list alphabetically ordered.

View file

@ -8,6 +8,7 @@ summary: 'What we do between each releases'
Plume follows semantic versionning. The 0.x series is for alpha versions. The `x` doesn't actually correspond
to the alpha number, because `0.1.0` was before the first release, and `0.2.0` was the first alpha.
This has been fixed with the fourth alpha, which is the `0.4.0` version, by skipping the third alpha.
Beta versions or pre-release uses the `-rcX` suffix, where `X` is the number of the release canditate.