docs: align delegation scope and deployment guidance

This commit is contained in:
Marco Allegretti 2026-01-29 00:47:40 +01:00
parent d8b2b0af14
commit 8ad0ac8a7a
8 changed files with 17 additions and 22 deletions

View file

@ -28,7 +28,7 @@ Welcome to the Likwid documentation. This guide covers everything you need to kn
- **Demo Instance**: Explore a live demo at `/demo` - **Demo Instance**: Explore a live demo at `/demo`
- **Source Code**: [Codeberg](https://codeberg.org/likwid/likwid) - **Source Code**: [Codeberg](https://codeberg.org/likwid/likwid)
- **License**: AGPLv3 - **License**: EUPL-1.2
## Contributing ## Contributing

View file

@ -59,8 +59,8 @@ podman exec likwid-prod-db pg_dump -U likwid likwid_prod > backup.sql
```bash ```bash
# Drop and recreate database # Drop and recreate database
psql -h localhost -U postgres -c "DROP DATABASE IF EXISTS likwid_prod;" psql -h localhost -U likwid -d postgres -c "DROP DATABASE IF EXISTS likwid_prod;"
psql -h localhost -U postgres -c "CREATE DATABASE likwid_prod OWNER likwid;" psql -h localhost -U likwid -d postgres -c "CREATE DATABASE likwid_prod OWNER likwid;"
# Restore from dump # Restore from dump
pg_restore -h localhost -U likwid -d likwid_prod backup.dump pg_restore -h localhost -U likwid -d likwid_prod backup.dump
@ -91,7 +91,7 @@ The demo instance can be reset to initial state:
./scripts/demo-reset.sh ./scripts/demo-reset.sh
``` ```
This removes all data and re-runs migrations with seed data. This removes all demo data by recreating the demo database volume; on startup the backend runs core migrations and demo seed migrations to restore the initial demo dataset.
## Disaster Recovery Plan ## Disaster Recovery Plan

View file

@ -21,6 +21,7 @@ Likwid is configured through environment variables and database settings.
|----------|----------|---------|-------------| |----------|----------|---------|-------------|
| `API_BASE` | No | `http://localhost:3000` | Backend API URL | | `API_BASE` | No | `http://localhost:3000` | Backend API URL |
| `PUBLIC_API_BASE` | No | Same as API_BASE | Public-facing API URL | | `PUBLIC_API_BASE` | No | Same as API_BASE | Public-facing API URL |
| `INTERNAL_API_BASE` | No | - | Server-side API URL (e.g. `http://backend:3000` in container deployments) |
## Instance Settings ## Instance Settings

View file

@ -49,7 +49,7 @@ sqlx migrate add <migration_name>
| `delegations` | Delegation relationships | | `delegations` | Delegation relationships |
| `moderation_log` | Audit trail | | `moderation_log` | Audit trail |
| `comments` | Discussion comments | | `comments` | Discussion comments |
| `topics` | Categorization for delegation | | `topics` | Categorization for proposals |
## Backup ## Backup

View file

@ -21,7 +21,7 @@ An option that would beat every other option in a head-to-head comparison. The S
A user who receives delegated voting power from other users. A user who receives delegated voting power from other users.
### Delegation ### Delegation
The act of entrusting your vote to another user. Can be topic-based or community-wide. The act of entrusting your vote to another user.
### Deliberation ### Deliberation
The discussion phase of a proposal where members debate and refine ideas before voting. The discussion phase of a proposal where members debate and refine ideas before voting.
@ -77,7 +77,7 @@ A voting method where voters rank options. Also called Instant Runoff Voting (IR
A Condorcet voting method that uses pairwise comparisons and strongest paths to determine the winner. A Condorcet voting method that uses pairwise comparisons and strongest paths to determine the winner.
### Scope ### Scope
The extent of a delegation - can be community-wide or limited to specific topics. The extent of a delegation - for example, global or community-wide.
### STAR Voting ### STAR Voting
Score Then Automatic Runoff - voters rate options 0-5 stars, top two enter automatic runoff. Score Then Automatic Runoff - voters rate options 0-5 stars, top two enter automatic runoff.
@ -85,7 +85,7 @@ Score Then Automatic Runoff - voters rate options 0-5 stars, top two enter autom
## T ## T
### Topic ### Topic
A category or subject area used to organize proposals and delegations. A category or subject area used to organize proposals.
### Transitive Delegation ### Transitive Delegation
When delegation chains are followed (A delegates to B, B delegates to C, so A's vote goes to C). When delegation chains are followed (A delegates to B, B delegates to C, so A's vote goes to C).

View file

@ -14,22 +14,17 @@ Delegation allows you to entrust your vote to someone you trust, while retaining
### Community-Wide ### Community-Wide
Your delegate votes on all proposals in a community. Your delegate votes on all proposals in a community.
### Topic-Based ### Global
Your delegate only votes on proposals tagged with specific topics: Your delegate votes on proposals across the instance.
- Architecture
- Budget
- Policy
- Security
- etc.
## Creating a Delegation ## Creating a Delegation
1. Go to **Settings** **Delegations** 1. Go to **Delegations**
2. Click **Add Delegation** 2. Click **Add Delegation**
3. Select: 3. Select:
- The delegate (user you trust) - The delegate (user you trust)
- The community - The community
- The scope (all topics or specific topics) - The scope (global or community)
4. Confirm 4. Confirm
## Finding Delegates ## Finding Delegates
@ -42,7 +37,7 @@ Look for users who:
Delegate profiles show: Delegate profiles show:
- Their voting policy - Their voting policy
- Number of current delegators - Number of current delegators
- Topic expertise - Areas of expertise
## Delegation Chains ## Delegation Chains
@ -62,7 +57,7 @@ All delegations are visible:
## Revoking Delegation ## Revoking Delegation
1. Go to **Settings** **Delegations** 1. Go to **Delegations**
2. Find the delegation to revoke 2. Find the delegation to revoke
3. Click **Revoke** 3. Click **Revoke**
4. The delegation ends immediately 4. The delegation ends immediately
@ -70,6 +65,5 @@ All delegations are visible:
## Best Practices ## Best Practices
- **Delegate to active members** who participate regularly - **Delegate to active members** who participate regularly
- **Use topic-based delegation** for specialized decisions
- **Review your delegations** periodically - **Review your delegations** periodically
- **Vote directly** on issues you care deeply about - **Vote directly** on issues you care deeply about

View file

@ -41,7 +41,7 @@ Before voting, read the full proposal text and deliberation history. Likwid enco
### 4. Participate ### 4. Participate
- **Comment** on proposals during the discussion phase - **Comment** on proposals during the discussion phase
- **Vote** when voting opens - **Vote** when voting opens
- **Delegate** your vote to trusted members on specific topics - **Delegate** your vote to trusted members (globally or within a community)
## Understanding the Interface ## Understanding the Interface

View file

@ -70,7 +70,7 @@ The author creates a proposal with:
## Delegation and Voting ## Delegation and Voting
If you've delegated your vote on a topic: If you've delegated your vote (globally or within a community):
- Your delegate votes on your behalf - Your delegate votes on your behalf
- You can override by voting directly - You can override by voting directly
- Delegations are transparent - Delegations are transparent