Merge pull request 'doc-typo' (#100) from Marius/documentation:doc-typo into main

Reviewed-on: plume/documentation#100
main
KitaitiMakoto 3 years ago
commit 36d1898f08

@ -10,7 +10,7 @@ abnormal (unexpected behavior, display issue, a grammar mistake, etc), you can r
## If you have a Gitea or GitHub account
If the issue is about Plume itself, go on [Gitea issues page](https://git.joinplu.me/Plume/Plume/issues/new) or [GitHub issues page](https://github.com/Plume-org/Plume/issues/new?assignees=&labels=C%3A+Bug&template=bug_report.md&title=).
If the issue is about Plume itself, go on [Gitea issues page](https://git.joinplu.me/Plume/Plume/issues/new) ([GitHub issues page](https://github.com/Plume-org/Plume/issues/new?assignees=&labels=C%3A+Bug&template=bug_report.md&title=)).
Then, all you have to do is to fill the title and the description of your issue, and to validate.
If your issue isn't about Plume itself, find the appropriate repository [in the list](https://git.joinplu.me/Plume)([GitHub](https://github.com/Plume-org)), go to the "Issues"

@ -9,26 +9,13 @@ Some people contribute to Plume by improving it's source code. They propose chan
software throught what is called "pull requests" on Gitea or GitHub (thus you will need to create a Gitea
or GitHub account to follow this guide, if you don't have one yet).
Here is the [list of all pull requests needing to be reviewed]()([GitHub](https://github.com/Plume-org/Plume/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+review%3Arequired+label%3A%22S%3A+Ready+for+review%22)).
Here is the [list of all pull requests needing to be reviewed](https://git.joinplu.me/Plume/Plume/pulls?q=&labels=57)([GitHub](https://github.com/Plume-org/Plume/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+review%3Arequired+label%3A%22S%3A+Ready+for+review%22)).
Choose one that seems interesting to you, read the discussion for context about what needs to be reviewed,
and what was already tested, and start your review.
## Test the changes
Each pull request is deployed in live so that you can easily test the changes they bring.
The URL to access the test instance is `https://pr-XXX.joinplu.me/`, where `XXX` is the number
of the pull request (that is shown next to the title on GitHub).
A list of all running test instances is also available on [pr-list.joinplu.me](https://joinplu.me). Only
five instances may run at the same time, to avoid to overload our server. If the instance you wanted to access
is not available, wait for the CI to run again (it will restart it), choose another pull request, or test it locally
if you know how to do it.
A good start is to go to the test instance for your pull request, and to see if everything works as expected,
but also to try to find some corner cases that were not expected, and that may break something.
Don't hesitate to try the feature on different devices too, and from different browser, especially if it changes
the user interface.
Todo : to be documented
## Review the code

@ -10,7 +10,7 @@ Plume is mostly made in Rust. The back-end uses Rocket and Diesel. The front-end
is in Rust too, thanks to WebAssembly. The stylesheets are written in SCSS.
If you want to write some code but you don't really know where to start, you
can try to find [an issue that interests you](https://git.joinplu.me/Plume/Plume/issues))([GitHub](https://github.com/Plume-org/Plume/issues)).
can try to find [an issue that interests you](https://git.joinplu.me/Plume/Plume/issues) ([GitHub](https://github.com/Plume-org/Plume/issues)).
Then, fork Plume (if you didn't already do it), `git clone` your fork, and start a
new branch with `git checkout -b NAME-OF-THE-BRANCH`. You can now start to work on the

@ -11,14 +11,13 @@ you have to propose.
## It may need to be discussed
If your feature is controversial, or not totally clear yet, the best is to open a new issue
on [Gitea](https://git.joinplu.me/Plume/Plume/issues/new) or [GitHub](https://github.com/Plume-org/Plume/issues/new?template=feature_request.md).
on [Gitea](https://git.joinplu.me/Plume/Plume/issues/new) ([GitHub](https://github.com/Plume-org/Plume/issues/new?template=feature_request.md)).
Give as much details as possible. Especially, explain which problem you are trying to solve with this new feature.
## It doesn't really need to be discussed
Then you can open on [Gitea](https://git.joinplu.me/Plume/Plume/issues/new) or
[GitHub](https://github.com/Plume-org/Plume/issues/new?template=feature_request.md),
Then you can open on [Gitea](https://git.joinplu.me/Plume/Plume/issues/new) ([GitHub](https://github.com/Plume-org/Plume/issues/new?template=feature_request.md)),
if you have an account there. Just fill the information asked in the form, and click "Submit new issue".
If you don't have a GitHub account, you can also suggest your feature in [the Matrix room](/contribute/discussion), and we
If you don't have a Gitea nor GitHub account, you can also suggest your feature in [the Matrix room](/contribute/discussion), and we
will create the issue for you.

@ -25,8 +25,8 @@ meaning that all your users will get disconnected. You can generate one with `op
- `SEARCH_LANG`: the shortcut for the combination of `SEARCH_TAG_TOKENIZER` and `SEARCH_CONTENT_TOKENIZER`. Currently supports only `ja` and it requires `search-lindera` feature on build. This is experimental and might change in the future. Since v0.5.0.
- `MEDIA_UPLOAD_DIRECTORY`: the directory in which to store the uploaded medias (`./static/media` by default). Plume won't create this directory if it doesn't exist, so make sure to create it before.
- `DEFAULT_THEME`: the name of the default theme. It should be the same as the name of the directory containing the theme in `static/css`.
- `DB_MAX_SIZE`: the maximum number of database connections (`10` by default). Since 0.5.0.
- `DB_MIN_IDLE`: the minimum idle database connection count (the same to `DB_MAX_SIZE` by default). Since 0.5.0.
- `DB_MAX_SIZE`: the maximum number of database connections (`10` by default). Since v0.5.0.
- `DB_MIN_IDLE`: the minimum idle database connection count (the same to `DB_MAX_SIZE` by default). Since v0.5.0.
## Mail
@ -74,7 +74,7 @@ PLUME_LOGO_512=icons/trwnh/paragraphs/plumeParagraphs512.png
Plume support delegating authentication via LDAP.
- `LDAP_ADDR`: address of the LDAP server
- `LDAP_BASE_DN`: base DN used when binding, see explanation below
- `LDAP_USER_NAME_ATTR`: attribut with user name ised when binding, see explanation below (default=`cn`)
- `LDAP_USER_NAME_ATTR`: attribut with user name used when binding, see explanation below (default=`cn`)
- `LDAP_USER_MAIL_ATTR`: attribut containing the mail address of the user (default=`mail`)
- `LDAP_TLS`: connect to the LDAP server using TLS (default=false)

@ -2,7 +2,7 @@
title: Configuring Caddy
---
The Caddy configuration is very short.
The Caddy v1 configuration is very short.
```
DOMAIN_NAME {
@ -12,6 +12,14 @@ DOMAIN_NAME {
}
```
The Caddy v2 configuration is shorter.
```
DOMAIN_NAME {
reverse_proxy localhost:7878
}
```
Don't forget to replace `DOMAIN_NAME` with your own domain.
Restart Caddy, and your Plume instance should be accessible!
Restart Caddy, and your Plume instance should be accessible!

@ -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 variable in your shell:
- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP or `sqlite` in the file name. Choose which you want.
- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP` or `sqlite` in the file name. Choose which you want.
Then run these commands:

@ -66,7 +66,7 @@ We publish x86 docker images on Docker Hub. ARM images are hosted by [Lollipop C
## Joining one of these places
We will eventually ask you if you want to be added the Gitea or GitHib organization, as a Crowdin manager, to the Matrix moderators
We will eventually ask you if you want to be added the Gitea or GitHub organization, as a Crowdin manager, to the Matrix moderators
or to the authors of *~PlumeDev@fediverse.blog*.
If you consider we should add you, you can also ask by yourselve.

@ -6,7 +6,7 @@ Prebuilt binaries are only available for 64 bits Linux machines.
You'll need to define a variable in your shell first:
- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP or `sqlite` in the file name. Choose which you want.
- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP` or `sqlite` in the file name. Choose which you want.
Then run these commands:

Loading…
Cancel
Save