Skip to content

Commit

Permalink
add admin UI documentation, fix title for no-subdomain doc
Browse files Browse the repository at this point in the history
  • Loading branch information
paskal committed Feb 24, 2022
1 parent d4481d1 commit 02164ce
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 14 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Remark42 is a self-hosted, lightweight and simple (yet functional) comment engin
* Clean, lightweight and customizable UI with white and dark themes
* Multi-site mode from a single instance
* Integration with automatic SSL (direct and via [nginx-le](https://github.com/nginx-le/nginx-le))
* [Privacy focused](#privacy)
* [Privacy focused](https://remark42.com/#privacy)

[Demo site](https://remark42.com/demo/) available with all authentication methods, including email auth and anonymous access.

Expand All @@ -32,7 +32,7 @@ Remark42 is a self-hosted, lightweight and simple (yet functional) comment engin
Comments example:
![](screenshots/comments.png)

For admin screenshots see [Admin UI wiki](https://github.com/umputun/remark42/wiki/Admin-UI)
For admin screenshots see [Admin UI documentation](https://remark42.com/docs/manuals/admin-interface/)
</details>

All remark42 documentation is available [by the link](https://remark42.com/docs/getting-started/installation/).
Expand Down
5 changes: 0 additions & 5 deletions site/src/docs/getting-started/system-requirements/index.md

This file was deleted.

File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
18 changes: 18 additions & 0 deletions site/src/docs/manuals/admin-interface/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Admin UI
---

Administrators defined by `admin.shared.id` / `$ADMIN_SHARED_ID` and get the following extra control elements:

![Admin interface](images/admin-primary.png)

1. **Show settings - lists of blocked and hidden users.**
![Blocker and hidden users](images/admin-settings.png)

2. **Disable comments for the post. Can be enabled back anytime.**

3. **Block user permanently or temporary.**
![Block users](images/admin-blocking.png)

4. **Delete a comment**
![Delete a comment](images/admin-delete.png)
4 changes: 2 additions & 2 deletions site/src/docs/manuals/subdomain/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configure Instance on Subdomain
title: Configure Instance without Subdomain
---

## How to configure remark42 without a subdomain
Expand Down Expand Up @@ -45,7 +45,7 @@ services:
The `nginx.conf` would then look something like:

```
```nginx
location /remark42/ {
rewrite /remark42/(.*) /$1 break;
proxy_pass http://remark42:8080/; // use internal docker name of remark42 container for proxy
Expand Down
10 changes: 5 additions & 5 deletions site/src/docs/nav.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@
{
"title": "Installation",
"href": "/getting-started/installation/"
},
{
"title": "System Requirements",
"href": "/getting-started/system-requirements/"
}
]
},
Expand Down Expand Up @@ -45,7 +41,11 @@
"section": "Manuals",
"children": [
{
"title": "Subdomain",
"title": "Admin UI",
"href": "/manuals/admin-interface/"
},
{
"title": "Without subdomain",
"href": "/manuals/subdomain/"
},
{
Expand Down

0 comments on commit 02164ce

Please sign in to comment.