mirrors/remark42
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

clean up formatting and typos in documentation

Browse Source
This commit is contained in:
Dmitry Verkhoturov
2020-10-19 02:42:19 -05:00
committed by Umputun
parent 6f122f93d1
commit 91580194e9
7 changed files with 35 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/1.6/email.md
+13 -6
View File
@@ -14,13 +14,15 @@ This documentation describes how to enable the email-related capabilities of Rem
- email notifications for any users except anonymous:
GitHub or Google or Twitter or any other kind of user gets the ability to get email notifications about new replies to their comments:
GitHub or Google or Twitter or any other kind of user gets the ability to get
email notifications about new replies to their comments:
![Email notifications subscription](/docs/1.6/images/email_notifications.png?raw=true)
## Setup email server connection
To enable any of email functionality you need to set up email (SMTP) server connection using these variables:
To enable any of email functionality you need to set up email
(SMTP) server connection using these variables:
```
SMTP_HOST
@@ -160,9 +162,12 @@ Configuration example for [Amazon SES](https://aws.amazon.com/ses/) (us-east-1 r
- NOTIFY_EMAIL_FROM=notify@example.com
```
A domain or an email that will be used in `AUTH_EMAIL_FROM` or `NOTIFY_EMAIL_FROM` must first be [verified](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domain-procedure.html).
A domain or an email that will be used in `AUTH_EMAIL_FROM` or `NOTIFY_EMAIL_FROM`
must first be [verified](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domain-procedure.html).
[SMTP Credentials](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html) must first be obtained from [Amazon SES Console](https://console.aws.amazon.com/ses/home?region=us-east-1#smtp-settings:):
[SMTP Credentials](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html)
must first be obtained from
[Amazon SES Console](https://console.aws.amazon.com/ses/home?region=us-east-1#smtp-settings:):
## Setup email authentication
@@ -183,8 +188,10 @@ After you set `SMTP_` variables, you can allow email authentication by setting t
- AUTH_EMAIL_FROM=notify@example.com
```
Usually, you don't need to change/set anything else. In case if you want to use a different email template set `AUTH_EMAIL_TEMPLATE`, for instance
`- AUTH_EMAIL_TEMPLATE="Confirmation email, token: {{.Token}}"`. See [verified-authentication](https://github.com/go-pkgz/auth#verified-authentication) for more details.
Usually, you don't need to change/set anything else. In case if you want to use a different
email template set `AUTH_EMAIL_TEMPLATE`, for instance
`- AUTH_EMAIL_TEMPLATE="Confirmation email, token: {{.Token}}"`.
See [verified-authentication](https://github.com/go-pkgz/auth#verified-authentication) for more details.
## Setup email notifications
docs/1.6/telegram.md
+1 -1
View File
@@ -6,7 +6,7 @@ title: Telegram
In order to integrate notifications from remark42 with the [telegram](https://telegram.org), you should make [a channel](https://telegram.org/faq_channels) and obtain a token. This token should be used as `NOTIFY_TELEGRAM_TOKEN`. You also need to set `NOTIFY_TYPE=telegram` and set `NOTIFY_TELEGRAM_CHAN` to your channel.
In order to get token "just talk to [BotFather](https://core.telegram.org/bots#6-botfather)". All you need is to send `/newbot` command, choose bot name and the name for your bot (it must end in `bot`). This is it, you got a token.
In order to get token "just talk to [BotFather](https://core.telegram.org/bots#6-botfather)". All you need is to send `/newbot` command, and choose the name for your bot (it must end in `bot`). This is it, you got a token.
_Example of such a "talk":_
docs/1.6/translation.md
+2 -2
View File
@@ -29,7 +29,7 @@ below in order to have your translation start being available to all remark42 us
git rebase upstream/master
git push
```
1. add new locale with [two-letter code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
1. add a new locale with [two-letter code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
of the language you want to make the translation into to list in
[frontend/tasks/supportedLocales.json](https://github.com/umputun/remark42/blob/master/frontend/tasks/supportedLocales.json)
1. run `npm run translation:generate` in `frontend` folder
@@ -49,7 +49,7 @@ below in order to have your translation start being available to all remark42 us
```
1. open [http://127.0.0.1:8080](http://127.0.0.1:8080), log in, make a comment, make a reply to a comment,
and make sure that your translation looks as you expect it to look
and make sure your translation looks as you expect it to look
1. make a screenshot from [http://127.0.0.1:8080](http://127.0.0.1:8080) with your translation in place
1. after all previous steps are done, create a [Pull Request](https://github.com/umputun/remark42/pulls) to umputun/remark42
docs/latest/developers-guide/email-templates.md
+1 -1
View File
@@ -1,7 +1,7 @@
### Email templating
We use golang templates for email templating.
templates located in `backend/templates` and embeded into binary by statik
templates located in `backend/templates` and embedded into binary by statik
For getting access to files you can use package `templates` from `backend/app/templates`
docs/latest/email.md
+15 -8
View File
@@ -10,17 +10,19 @@ This documentation describes how to enable the email-related capabilities of Rem
enabling this will let the user log in using their emails:
![Email authentication](/docs/latest/images/email_auth.png?raw=true))
![Email authentication](/docs/latest/images/email_auth.png?raw=true)
- email notifications for any users except anonymous:
GitHub or Google or Twitter or any other kind of user gets the ability to get email notifications about new replies to their comments:
GitHub or Google or Twitter or any other kind of user gets the ability to get
email notifications about new replies to their comments (and any of the replies down the tree):
![Email notifications subscription](/docs/latest/images/email_notifications.png?raw=true))
![Email notifications subscription](/docs/latest/images/email_notifications.png?raw=true)
## Setup email server connection
To enable any of email functionality you need to set up email (SMTP) server connection using these variables:
To enable any of email functionality you need to set up email
(SMTP) server connection using these variables:
```
SMTP_HOST
@@ -160,9 +162,12 @@ Configuration example for [Amazon SES](https://aws.amazon.com/ses/) (us-east-1 r
- NOTIFY_EMAIL_FROM=notify@example.com
```
A domain or an email that will be used in `AUTH_EMAIL_FROM` or `NOTIFY_EMAIL_FROM` must first be [verified](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domain-procedure.html).
A domain or an email that will be used in `AUTH_EMAIL_FROM` or `NOTIFY_EMAIL_FROM`
must first be [verified](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domain-procedure.html).
[SMTP Credentials](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html) must first be obtained from [Amazon SES Console](https://console.aws.amazon.com/ses/home?region=us-east-1#smtp-settings:):
[SMTP Credentials](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html)
must first be obtained from
[Amazon SES Console](https://console.aws.amazon.com/ses/home?region=us-east-1#smtp-settings:):
## Setup email authentication
@@ -183,8 +188,10 @@ After you set `SMTP_` variables, you can allow email authentication by setting t
- AUTH_EMAIL_FROM=notify@example.com
```
Usually, you don't need to change/set anything else. In case if you want to use a different email template set `AUTH_EMAIL_TEMPLATE`, for instance
`- AUTH_EMAIL_TEMPLATE="Confirmation email, token: {{.Token}}"`. See [verified-authentication](https://github.com/go-pkgz/auth#verified-authentication) for more details.
Usually, you don't need to change/set anything else. In case if you want to use a different
email template set `AUTH_EMAIL_TEMPLATE`, for instance
`- AUTH_EMAIL_TEMPLATE="Confirmation email, token: {{.Token}}"`.
See [verified-authentication](https://github.com/go-pkgz/auth#verified-authentication) for more details.
## Setup email notifications
docs/latest/telegram.md
+1 -1
View File
@@ -6,7 +6,7 @@ title: Telegram
In order to integrate notifications from remark42 with the [telegram](https://telegram.org), you should make [a channel](https://telegram.org/faq_channels) and obtain a token. This token should be used as `NOTIFY_TELEGRAM_TOKEN`. You also need to set `NOTIFY_TYPE=telegram` and set `NOTIFY_TELEGRAM_CHAN` to your channel.
In order to get token "just talk to [BotFather](https://core.telegram.org/bots#6-botfather)". All you need is to send `/newbot` command, choose bot name and the name for your bot (it must end in `bot`). This is it, you got a token.
In order to get token "just talk to [BotFather](https://core.telegram.org/bots#6-botfather)". All you need is to send `/newbot` command, and choose the name for your bot (it must end in `bot`). This is it, you got a token.
_Example of such a "talk":_
docs/latest/translation.md
+2 -2
View File
@@ -29,7 +29,7 @@ below in order to have your translation start being available to all remark42 us
git rebase upstream/master
git push
```
1. add new locale with [two-letter code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
1. add a new locale with [two-letter code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
of the language you want to make the translation into to list in
[frontend/tasks/supportedLocales.json](https://github.com/umputun/remark42/blob/master/frontend/tasks/supportedLocales.json)
1. run `npm install` in `frontend` folder
@@ -51,7 +51,7 @@ below in order to have your translation start being available to all remark42 us
```
1. open [http://127.0.0.1:8080/web](http://127.0.0.1:8080/web), log in, make a comment, make a reply to a comment,
and make sure that your translation looks as you expect it to look
and make sure your translation looks as you expect it to look
1. make a screenshot from [http://127.0.0.1:8080](http://127.0.0.1:8080) with your translation in place
1. after all previous steps are done, create a [Pull Request](https://github.com/umputun/remark42/pulls) to umputun/remark42