diff --git a/README.md b/README.md index 4a5bf503..737b27a5 100644 --- a/README.md +++ b/README.md @@ -488,7 +488,7 @@ And then add this node in the place where you want to see Remark42 widget: After that widget will be rendered inside this node. -If you want to set this up on a Single Page App, see [appropriate doc page](https://github.com/umputun/remark42/blob/master/docs/latest/spa.md). +If you want to set this up on a Single Page App, see [appropriate doc page](https://github.com/umputun/remark42/blob/master/docs/spa.md). ##### Themes @@ -508,7 +508,7 @@ window.REMARK42.changeTheme('light'); Right now Remark is translated to en, ru (partially), de, and fi languages. You can pick one using [configuration object](#setup-on-your-website). -Do you want translate remark42 to other locale? Please see [this documentation](https://github.com/umputun/remark42/blob/master/docs/latest/translation.md) for details. +Do you want translate remark42 to other locale? Please see [this documentation](https://github.com/umputun/remark42/blob/master/docs/translation.md) for details. #### Last comments diff --git a/docs/email.md b/docs/email.md index b1497dc1..7ba14bd8 100644 --- a/docs/email.md +++ b/docs/email.md @@ -10,14 +10,14 @@ 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/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 (and any of the replies down the tree): - ![Email notifications subscription](/docs/latest/images/email_notifications.png?raw=true) + ![Email notifications subscription](/docs/images/email_notifications.png?raw=true) ## Setup email server connection @@ -51,7 +51,7 @@ This is an example of a configuration using [Mailgun](https://www.mailgun.com/) When you don't want to expose your IP (which is impossible with any SMTP provider) and for situations when connecting to external SMTP server is impossible due to firewall -settings is setting up an SMTP-to-API bridge and sending messages trough it. +settings is setting up an SMTP-to-API bridge and sending messages through it. To use any of containers below with in remark42 environment set following two `SMTP` variables: @@ -104,7 +104,7 @@ This is an example of a configuration using [SendGrid](https://sendgrid.com/) em When you don't want to expose your IP (which is impossible with any SMTP provider) and for situations when connecting to external SMTP server is impossible due to firewall -settings is setting up an SMTP-to-API bridge and sending messages trough it. +settings is setting up an SMTP-to-API bridge and sending messages through it. To use any of containers below with in remark42 environment set following two `SMTP` variables: diff --git a/docs/kubernetes.md b/docs/kubernetes.md index de909c58..34c19d46 100644 --- a/docs/kubernetes.md +++ b/docs/kubernetes.md @@ -88,7 +88,7 @@ spec: cpu: "1" memory: "1Gi" securityContext: - # Has its own root priviledge drop. Can't do runAsUser / runAsGroup. + # Has its own root privilege drop. Can't do runAsUser / runAsGroup. volumes: - name: srvvar persistentVolumeClaim: diff --git a/docs/nginx-proxy.md b/docs/nginx-proxy.md index 47610374..b667d936 100644 --- a/docs/nginx-proxy.md +++ b/docs/nginx-proxy.md @@ -51,4 +51,4 @@ server { } ``` -note: `proxy_pass` points to internal DNS name `remark42` and expected to run from the same compose. If nginx runs outside of compose the real IP (or docker's bridge IP) should be used +note: `proxy_pass` points to internal DNS name `remark42` and expected to run from the same compose. If nginx runs outside compose the real IP (or docker's bridge IP) should be used diff --git a/docs/reproxy.md b/docs/reproxy.md index 377e53a7..2bb0f66a 100644 --- a/docs/reproxy.md +++ b/docs/reproxy.md @@ -2,9 +2,9 @@ title: Reproxy --- -## How to configure remark42 with [reproxy](https://reproxy.io) +## How to configure remark42 with [Reproxy](https://reproxy.io) -Example of reproxy configuration (reverse proxy) running remark42 service on remark42.example.com with docker compose. Reproxy handles SSL termination with LE and gzip all the responses. +Example of Reproxy configuration (reverse proxy) running remark42 service on remark42.example.com with docker compose. Reproxy handles SSL termination with LE and gzip all the responses. ```yaml version: "3.4" diff --git a/docs/slack.md b/docs/slack.md index a01f9cbd..319cc08a 100644 --- a/docs/slack.md +++ b/docs/slack.md @@ -20,7 +20,7 @@ In order to integrate notifications from remark42 with the [slack](https://slack The slack token which you obtained before should be used as `NOTIFY_SLACK_TOKEN`. -You also need to set `NOTIFY_ADMINS=slack` for the slack notification to be active. +You also need to set `NOTIFY_ADMINS=slack` for the Slack notification to be active. By default, the notification are sent to the `general` channel on slack. If you need another channel, you can specify it, for instance with `NOTIFY_SLACK_CHAN=random`. @@ -33,7 +33,7 @@ By default, the notification are sent to the `general` channel on slack. If you ### Verify the notifications on Slack -If all goes fine, you should be able to see the following message on your slack notification channel: +If all goes fine, you should be able to see the following message on your Slack notification channel: > New comment from _author_ -> _original author_ >> [Demo | Remark42](http://127.0.0.1:8080/web/#remark42__comment-11288987987) diff --git a/docs/spa.md b/docs/spa.md index 777ff189..f7e12f07 100644 --- a/docs/spa.md +++ b/docs/spa.md @@ -25,7 +25,7 @@ Originally tested on [Nuxt.js](https://nuxtjs.org/), but it should be applicable }) ``` -- Created `remark42Instance` when the `div` containing remark42 has appear, usually at `mounted` or `componentDidMount` of the SPA lifecycle. Destroy the previous instance first, if neccessary. +- Created `remark42Instance` when the `div` containing remark42 has appeared, usually at `mounted` or `componentDidMount` of the SPA lifecycle. Destroy the previous instance first, if necessary. ```ts initRemark42() { diff --git a/frontend/README.md b/frontend/README.md index 8124ce1a..039f0f22 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -29,7 +29,7 @@ ### How to add new locale -Please see [this documentation](https://github.com/umputun/remark42/blob/master/docs/latest/translation.md). +Please see [this documentation](https://github.com/umputun/remark42/blob/master/docs/translation.md). ### Notes diff --git a/site/src/docs/configuration/index.md b/site/src/docs/configuration/index.md index 60271840..47e10773 100644 --- a/site/src/docs/configuration/index.md +++ b/site/src/docs/configuration/index.md @@ -1,6 +1,6 @@ --- layout: redirect.njk -destination: /docs/configuration/frondend/ +destination: /docs/configuration/frontend/ title: Configuration order: 200 --- diff --git a/site/src/docs/contributing/development-environment/index.md b/site/src/docs/contributing/development-environment/index.md index ae0ae40e..27cd6864 100644 --- a/site/src/docs/contributing/development-environment/index.md +++ b/site/src/docs/contributing/development-environment/index.md @@ -1,5 +1,5 @@ --- -title: Development Environmetn +title: Development Environment menuTitle: Environment parent: Contributing order: 300 diff --git a/site/src/docs/contributing/guidlines/backend/index.md b/site/src/docs/contributing/guidlines/backend/index.md index 78102c91..d193959b 100644 --- a/site/src/docs/contributing/guidlines/backend/index.md +++ b/site/src/docs/contributing/guidlines/backend/index.md @@ -1,5 +1,5 @@ --- -title: Backend Development Guidlines +title: Backend Development Guidelines menuTitle: Backend key: Backend Guidelines parent: Guidelines diff --git a/site/src/docs/contributing/guidlines/frontend/index.md b/site/src/docs/contributing/guidlines/frontend/index.md index b4c882c0..40a77670 100644 --- a/site/src/docs/contributing/guidlines/frontend/index.md +++ b/site/src/docs/contributing/guidlines/frontend/index.md @@ -1,5 +1,5 @@ --- -title: Frontend Development Guidlines +title: Frontend Development Guidelines menuTitle: Frontend key: Frontend Guidelines parent: Guidelines diff --git a/site/src/docs/contributing/technical-details/index.md b/site/src/docs/contributing/technical-details/index.md index d37dd7de..0c17ee10 100644 --- a/site/src/docs/contributing/technical-details/index.md +++ b/site/src/docs/contributing/technical-details/index.md @@ -16,11 +16,11 @@ All heavy REST calls cached internally in LRU cache limited by `CACHE_MAX_ITEMS` User's activity throttled globally (up to 1000 simultaneous requests) and limited locally (per user, usually up to 10 req/sec). Request timeout set to 60 seconds. -Admin authentication (`--admin-password` set) allows to hit Remark42 API without social login and with admin privileges. Adds basic-auth for username: admin, password: `${ADMIN_PASSWD}`. +Admin authentication (`--admin-password` set) allows hitting Remark42 API without social login and with admin privileges. Adds basic-auth for username: admin, password: `${ADMIN_PASSWD}`. User can vote for the comment multiple times but only to change the vote. Double-voting not allowed. -User can edit comments in 5 mins (configurable) window after creation. +User can edit comments in 5 minutes (configurable) window after creation. User ID hashed and prefixed by oauth provider name to avoid collisions and potential abuse. All avatars resized and cached locally to prevent rate limiters from oauth providers, part of `go-pkgz/auth` functionality. diff --git a/site/src/docs/getting-started/installation/index.md b/site/src/docs/getting-started/installation/index.md index 0be2e4c7..c09c4250 100644 --- a/site/src/docs/getting-started/installation/index.md +++ b/site/src/docs/getting-started/installation/index.md @@ -58,7 +58,7 @@ After that place the code snippet right after config. ::: note 💡 -**Note that:** You can place the config with the snippet in any place of the HTML code of your site. If it closer to start of the HTML (for example in ``) it will start loading sooner and show comments faster. +**Note that:** You can place the config with the snippet in any place of the HTML code of your site. If it is closer to start of the HTML (for example in ``) it will start loading sooner and show comments faster. ::: Put the next code snippet on a page of your site where you want to have comments: @@ -69,4 +69,4 @@ Put the next code snippet on a page of your site where you want to have comments After that widget will be rendered inside this node. -If you want to set this up on a Single Page App, see [appropriate doc page](https://github.com/umputun/remark42/blob/master/docs/latest/spa.md). +If you want to set this up on a Single Page App, see [appropriate doc page](https://github.com/umputun/remark42/blob/master/docs/spa.md). diff --git a/site/src/pages/index.md b/site/src/pages/index.md index fc1a59f5..7d20f99a 100644 --- a/site/src/pages/index.md +++ b/site/src/pages/index.md @@ -25,7 +25,7 @@ Remark42 gives you opportunity to have self-hosted, lightweight, and simple (yet - Export data to json with automatic backups - No external databases, everything embedded in a single data file - Fully dockerized and can be deployed in a single command -- Self-contained executable can be deployed directly to Linux, Windows and MacOS +- Self-contained executable can be deployed directly to Linux, Windows and macOS - Clean, lightweight and customizable UI with white and dark themes - Multi-site mode from a single instance - Integration with automatic SSL diff --git a/site/src/pages/redirects.md b/site/src/pages/redirects.md index 780359a4..0b19c64c 100644 --- a/site/src/pages/redirects.md +++ b/site/src/pages/redirects.md @@ -1,6 +1,6 @@ --- -# This file does hijinx with the "pagingation" system to generate many small pages from one set of data... -# and uses that do to redirects from some URLs to others. +# This file does hijinx with the "pagination" system to generate many small pages from one set of data... +# and uses that do to redirect from some URLs to others. # We use this to try to keep old links working. # # There's limited power to this approach (it only works for specific pages listed; it can't glob),