Reorganized Docs. In Progress.

This commit is contained in:
Lauri Ojansivu 2024-06-27 11:08:43 +03:00
parent 1961e22cbd
commit ce89ff4833
202 changed files with 0 additions and 0 deletions

View file

@ -0,0 +1,32 @@
## Standalone Wekan: Snap, (Docker, Source, VirtualBox)
1) [Install Wekan Snap](https://github.com/wekan/wekan-snap/wiki/Install)
2) Go to your Wekan URL like https://example.com/sign-up (your address + /sign-up)
3) Register your username, email address and password. First registered user will be admin, and next ones normal users. If you want other admins too, you can change their permission to admin at Admin Panel.
4) **If you get Internal Server Error when creating account, it's because you have not configured email, and you can ignore it. WORKING EMAIL IS NOT REQUIRED. Wekan works without setting up email.**
If you really want email sending, do for example:
```
sudo snap set wekan mail-url='smtps://user:pass@mailserver.example.com:457/'
sudo snap set wekan mail-from='Example Wekan Support <support@example.com>'
```
For more options see [Troubleshooting Email](Troubleshooting-Mail)
5) Login to Wekan at https://example.com/sign-in (your address + /sign-in)
6) Click on top right your username / Admin Panel. You can change permissions, name, email address and password in Admin Panel.
![Admin Panel](https://wekan.github.io/wekan-admin-panel.png)
7) For registering other users:
a) Let them self-register, or open webbrowser incongnito window, and register them at https://example.com/sign-up (your address + /sign-up)
b) If your email works, click Admin Panel / Settings / Registration / [X] Disable self-registration. Then invite new users to selected boards by email address.
## Deleting Users
[No delete feature yet](https://github.com/wekan/wekan/issues/1289)

View file

@ -0,0 +1,3 @@
[Wekan v5.55 and newer](https://github.com/wekan/wekan/blob/main/CHANGELOG.md#v555-2021-08-31-wekan-release)
<img src="https://wekan.github.io/allow-private-boards-only.png" width="60%" alt="Allow private boards only" />

View file

@ -0,0 +1,31 @@
These are on Standalone Wekan: Snap/Docker/Source/VirtualBox. Some of these are also at Sandstorm Wekan.
## Move to Archive: Restore possible
Board => ☰ => Move Board to Archive
Swimlane => ☰ => Move Swimlane to Archive
List => ☰ => Move List to Archive
Card => ☰ => Move Card to Archive
## Restore Card/List/Swimlane from Archive
Board => ☰ => Archive => Cards/Lists/Swimlanes Restore (or Delete - but that has no undo!! It's FINAL DELETE).
## Restore or Delete board
All Boards => Archive => Restore (or Delete - but that has no undo!! It's FINAL DELETE).
## Deleting - NO UNDO
Deleting Board: All Boards => Archive => Delete
Deleting Card: Card => ☰ => More => Delete (at right bottom corner)
Deleting List: List => ☰ => More => Delete (at right bottom corner)
Deleting Swimlane:
1) Swimlane => ☰ => Move Swimlane to Archive
2) Board => ☰ => Archive => Cards/Lists/Swimlanes Restore (or Delete - but that has no undo!! It's FINAL DELETE).

11
docs/Features/Cover.md Normal file
View file

@ -0,0 +1,11 @@
## Description
- Cover image = Image that you see first at not yet opened minicard, book, or magazine.
- Minicard = At board, small card, that you have not yet clicked to open card.
- Thumbnail Image = Small Picture of Attachment Image, like at Minicard and Card.
- At opened card, when you click thumbnail, it opens big picture slideshow.
## Minicard Cover Image and Count of attachments
<img src="https://wekan.github.io/cover/cover-and-attachment.png" width="100%" alt="Minicard Cover Image and Count of attachments" />

View file

@ -0,0 +1,29 @@
[Custom Fields issue](https://github.com/wekan/wekan/issues/807)
## To translators, about the word Custom
See other feature for description of Custom https://github.com/wekan/wekan/wiki/Customize-Translations
## 1) Click: Board hamburger menu / Custom Fields
<img src="https://wekan.github.io/custom-field-1.png" width="50%" alt="Custom Field Step 1" />
## 2) Click: Create Field, add details and Save
<img src="https://wekan.github.io/custom-field-2.png" width="50%" alt="Custom Field Step 1" />
## 3) Click: Card Details hamburger menu / Edit custom fields
<img src="https://wekan.github.io/custom-field-3.png" width="100%" alt="Custom Field Step 1" />
## 4) Click: Your Custom Field name to insert it to Card
<img src="https://wekan.github.io/custom-field-4.png" width="100%" alt="Custom Field Step 1" />
## 5) Click: Your selection from your Custom Field
<img src="https://wekan.github.io/custom-field-5.png" width="100%" alt="Custom Field Step 1" />
## 6) Custom Field is shown at Minicard and Card Details
<img src="https://wekan.github.io/custom-field-6.png" width="100%" alt="Custom Field Step 1" />

View file

@ -0,0 +1,24 @@
In Wekan v4.40 and newer:
- Custom Logo for Login and Top Left Corner.
- Optional link when clicking logo.
- Settings at Admin Panel / Settings / Layout.
Added [with this commit](https://github.com/wekan/wekan/commit/a7c3317ed696fad8e211b22afbb3012f3a4f2ddb). As you can see from that commit:
- Height 27 px in Top Left Corner Logo. Width auto = automatic.
- Width 300 px in Login Logo. Height auto = automatic.
Image can be for example jpg/png/gif/svg.
For those sizes, if logo is a little bigger or smaller, it will be zoomed.
## Storing logo images elsewhere
Add image like `https://example.com/logo.png`
## Storing logos in Wekan
1. Create board and change it from private to public (visible to everyone at Internet)
2. Add card
3. Add logo images to card as attachment
4. Right click on top image and copy image link to Admin Panel/Settings/Layout/Logo image URL

228
docs/Features/Features.md Normal file
View file

@ -0,0 +1,228 @@
# Current
Not all from [CHANGELOG](https://github.com/wekan/wekan/blob/main/CHANGELOG.md) are added to here yet.
## Kanban
### WIP Limits
![Wekan WIP Limits screenshot](https://wekan.github.io/screenshot-wip-limit.png)
### Boards: List of all your public and private boards, board shortcuts at top of page
![Wekan boards screenshot](https://wekan.github.io/screenshot-boards.png)
### Wekan full screen or window on desktop (without browser buttons etc)
[Info about browser standalone app mode](https://github.com/wekan/wekan/pull/1184)
### Wekan full screen on mobile Firefox
[Instructions and screenshot](https://github.com/wekan/wekan/issues/953#issuecomment-336537875)
### Restore archived board
![Wekan boards screenshot](https://wekan.github.io/screenshot-restore-board.png)
### Star board
![Wekan star board screenshot](https://wekan.github.io/screenshot-star-board.png)
### Watch board
![Wekan watch board screenshot](https://wekan.github.io/screenshot-muted-watch.png)
### Keyboard shortcuts button at bottom right corner
![Wekan watch board screenshot](https://wekan.github.io/screenshot-keyboard-shortcuts.png)
### Board menu when clicking 3 lines "hamburger" menu on right
![Wekan board menu screenshot](https://wekan.github.io/screenshot-board-menu.png)
### Member setting when clicking your username on top right corner
![Wekan member settings screenshot](https://wekan.github.io/screenshot-member-settings.png)
NOTE: Edit Notification duplicate was removed from above menu at https://github.com/wekan/wekan/pull/1948 so Edit Notification is only available at below menu screenshot.
### Member settings / Edit Notification
![Wekan edit notification screenshot](https://wekan.github.io/screenshot-member-settings-edit-notification.png)
### Member settings / Change settings
![Wekan hide system messages screenshot](https://wekan.github.io/screenshot-member-settings-hide-system-messages.png)
### Members: Click member initials or avatar
![Wekan members screenshot](https://wekan.github.io/screenshot-member-filter.png)
### Members: Click member initials or avatar => Permissions Admin/Normal/Comment only
![Wekan boards permissions screenshot](https://wekan.github.io/screenshot-member-comment-only.png)
### Lists: Add, archive and restore archived, delete list.
![Wekan kanban screenshot](https://wekan.github.io/screenshot-member-settings-archive.png)
### Cards: Description, Customizable Labels, Checklists, Attachment images and files, Comments. Archive and restore archived card. Delete card.
Tip: Normally you archive a card so you can restore it back. If you want to delete cards faster, drag cards to new list, and delete that new list. Deleting cannot be undone, more clicks are by design. There was previously easily clicked button to delete a list and people deleted important list by accident, and that bug report was fixed.
### [Markdown in card description and comments](https://github.com/wekan/wekan/issues/1038)
### [International Date Formatting for Due Date according to language](https://github.com/wekan/wekan/issues/838)
![Wekan kanban screenshot](https://wekan.github.io/screenshot.png)
### Cards: Drag and drop images to card. Paste images with Ctrl-V.
### 1) First attachment: Select Card 3 lines "hamburger" menu / Edit Attachments
![Wekan kanban screenshot](https://wekan.github.io/screenshot-drag1.png)
### 2) Select: Clipboard or drag and drop
![Wekan kanban screenshot](https://wekan.github.io/screenshot-drag4.png)
### 3) Drag and drop image, or Ctrl-V.
![Wekan kanban screenshot](https://wekan.github.io/screenshot-drag2.png)
### 4) Second image attachment and others can be added from Add Attachment button near first attachment.
![Wekan kanban screenshot](https://wekan.github.io/screenshot-drag3.png)
### Multi-selection => Checkmark select cards => drag-drop all selected to some list
![Wekan multi-selection screenshot](https://wekan.github.io/screenshot-multi-selection.png)
### Filtered views
![Wekan multi-selection screenshot](https://wekan.github.io/screenshot-filter.png)
## Authentication, Admin Panel, SMTP Settings
NOTE: There is user admin as "People" in Admin Panel, but no screenshot here yet.
* Source and Docker platforms: [Admin Panel](https://github.com/wekan/wekan/blob/main/CHANGELOG.md#v0111-rc2-2017-03-05-wekan-prerelease): Self-registration, or change to invite-only and inviting users to boards. SMTP Settings.
![Wekan Admin Panel registration disable screenshot](https://wekan.github.io/screenshot-admin-panel-registration.png)
![Wekan Admin Panel email screenshot](https://wekan.github.io/screenshot-admin-panel-email.png)
* Sandstorm Platform: Admin: LDAP, passwordless email, SAML, GitHub and Google Auth. Add and remove users. SMTP Settings. Wekan, Rocket.Chat, etc apps available with one click install.
## Import
* Import Trello board: Text, labels, images, comments, checklists. Not imported yet: stickers, etc.
* [Import Wekan board](https://github.com/wekan/wekan/pull/1117): Text, labels, images, comments, checklists.
## Export
* Export Wekan board: [Export menu item above the board archive item, when you click the sandwich bar icon on the top right](https://github.com/wekan/wekan/pull/1059). If Export menu is not visible, you can change [Export menu to be visible by setting yourself as board admin in MongoDB](https://github.com/wekan/wekan/issues/1060).
## Working with big boards
* [JSON tools, copying files to clipboard](https://github.com/wekan/wekan/issues/610#issuecomment-310862951)
## API
* [REST API Issue](https://github.com/wekan/wekan/issues/1037)
* [REST API Docs](REST-API)
* [Python client to REST API](https://github.com/wekan/wekan-python-api-client)
* [Wekan Sandstorm cards to CSV using Python](Wekan-Sandstorm-cards-to-CSV-using-Python)
## Webhooks
Sending notifications for board activities. Tested with [Slack](https://slack.com/) and [Rocket.chat](https://rocket.chat/).
```
Content-type: application/json
{
"text": "board activities"
[...]
}
```
Different activities send different webhook data. You can find the details in the wiki page [Webhook data](Webhook-data)
* [Outgoing Webhooks](https://github.com/wekan/wekan/pull/1119)
### Enabled
#### 1) Board menu when clicking 3 lines "hamburger" menu on right
![Wekan board menu screenshot](https://wekan.github.io/screenshot-board-menu.png)
#### 2) Outgoing Webhooks
![Wekan Outgoing Webhooks screenshot](https://wekan.github.io/screenshot-outgoing-webhooks.png)
### Disabled
Leave the URL field blank.
## Cleanup
* [Wekan database cleanup script](https://github.com/wekan/wekan-cleanup)
* [Docker cleanup](https://github.com/wekan/wekan/issues/985)
## Stats
* [Daily export of Wekan changes as JSON to Logstash and
ElasticSearch / Kibana (ELK)](https://github.com/wekan/wekan-logstash)
* [Statistics Python script for Wekan Dashboard](https://github.com/wekan/wekan-stats)
* [Console, file, and zulip logger on database changes](https://github.com/wekan/wekan/pull/1010) with [fix to replace console.log by winston logger](https://github.com/wekan/wekan/pull/1033)
## Versions of Meteor and Node
* Upgraded to [Meteor 1.4](https://github.com/wekan/wekan/pull/957) and [Node v4](https://github.com/wekan/wekan/issues/788) on [meteor-1.4 branch](https://github.com/wekan/wekan/tree/meteor-1.4)
## Translations
* [Translate Wekan at Transifex](https://app.transifex.com/wekan/)
![Wekan translations screenshot](https://wekan.github.io/screenshot-change-language.png)
# Already merged, will be at next version
* [Changelog](https://github.com/wekan/wekan/blob/main/CHANGELOG.md)
# Wishes for pull requests
### Existing pull requests, cleanup/cherry-picking/new pull requests welcome
* [Export/Import Excel TSV/CSV data](https://github.com/wekan/wekan/pull/413)
* [Move/Clone Board/List](https://github.com/wekan/wekan/pull/446) and [Move or copy cards from one board to another](https://github.com/wekan/wekan/issues/797) that [needs help in implementation](https://github.com/wekan/wekan/issues/979)
* [Replace CollectionFS with meteor-file-collection](https://github.com/wekan/wekan/pull/875)
### Wishes for API pull requests
* [Using API to script Email to board/card, notifications on cards to email, etc](https://github.com/wekan/wekan/issues/794)
### Wishes for Admin Panel
* [SMTP test, show possible errors on that test webpage](https://github.com/wekan/wekan/issues/949)
* [Teams/Organizations](https://github.com/wekan/wekan/issues/802) including Add/Modify/Remove Teams/Users/Passwords and Private/Public Team settings
* [Themes](https://github.com/wekan/wekan/issues/781) and making custom apps with Themes
### Wishes for Boards
* [Custom fields](https://github.com/wekan/wekan/issues/807)
* [Children/Related cards](https://github.com/wekan/wekan/issues/709), subtasks. Dependencies.
* [Top Level Projects](https://github.com/wekan/wekan/issues/641)
* [Swimlanes (rows)](https://github.com/wekan/wekan/issues/955)
* Kanban workflows
* Gantt charts
* [WIP limits](https://github.com/wekan/wekan/issues/783)
* [Timesheet/Time tracking](https://github.com/wekan/wekan/issues/812)
* Managing website
* [Same cards, multiple column sets](https://github.com/wekan/wekan/issues/211), related to [Themes](https://github.com/wekan/wekan/issues/781)
* [Calendar view](https://github.com/wekan/wekan/issues/808)
* [Vote on cards, number of votes, average](https://github.com/wekan/wekan/issues/796)
* [Board templates](https://github.com/wekan/wekan/issues/786)
* [Checklist templates](https://github.com/wekan/wekan/issues/904)
# More
[Platforms](Platforms)
[Integrations](Integrations)

35
docs/Features/IFTTT.md Normal file
View file

@ -0,0 +1,35 @@
## 1) Click: Menu item for the rules
<img src="https://wekan.github.io/ifttt/main_menu-ifttt.png" alt="Navigation menu for the rule dialog" />
## 2) Rule Menu: Overview, deleting and adding new rules
<img src="https://wekan.github.io/ifttt/ifttt_main_dialog.PNG" alt="Dialog Overview for the rules" />
## 2a) Add new rule : Triggers
Currently, there are three types of triggers: board, card and checklist
| Board | Card | Checklist |
| ------------- | ------------- | ------------- |
| create card | added/removed label, attachment, person | checklist added/removed |
| card moved to | | check item checked/unchecked |
| card moved from | | checklist completed |
## 2b) Add new rule : Actions
For every trigger, there are 4 types of actions: board, card, checklist and mail
| Board | Card | Checklist | Mail |
| ------------- | ------------- | ------------- | ------------- |
| move card to list | add/remove label, attachment, person | checklist add/remove | send email to |
| move to top/bottom | set title/description | check/uncheck item | |
| archive/unarchive | | checklist complete | |
# Example : How the rule works
* Rule 1: When a card is added to the board -> Add label yellow
* Rule 2: When a card is moved to List 2 -> Add checklist ToDo
* Rule 3: When a card is added to List 1 -> Add label blue
<img src="https://wekan.github.io/ifttt/how_to_work_with_rules.gif" alt="gif animation for rules" />

View file

@ -0,0 +1,5 @@
1. As Wekan Admin user, at `All Boards` page on top of board, click `Clone Board`
2. If cloned board does open correctly, check does it have any data missing.
3. If original board does not open correctly, at `All Boards` page on top of board icon click `Archive`
4. At `All Boards` page top right if buttons `Archive` and `Templates`. Click `Archive`.
5. If you don't need that original board anymore, click `Delete` to delete that original board permanently.

40
docs/Features/LaTeX.md Normal file
View file

@ -0,0 +1,40 @@
[Original issue](https://github.com/wekan/wekan/issues/4589)
[Commit](https://github.com/wekan/wekan/commit/82fa632197a0e3b88d26c557f1dc8cc18b05b18b)
## Examples
[Examples From NPM package](https://www.npmjs.com/package/markdown-it-mathjax3)
**Inline**
Surround your LaTeX with a single $ on each side for inline rendering.
`$\sqrt{3x-1}+(1+x)^2$`
**Block**
Use two ($$) for block rendering. This mode uses bigger symbols and centers the result.
```
$$\begin{array}{c}
\nabla \times \vec{\mathbf{B}} -\, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} &
= \frac{4\pi}{c}\vec{\mathbf{j}} \nabla \cdot \vec{\mathbf{E}} & = 4 \pi \rho \\
\nabla \times \vec{\mathbf{E}}\, +\, \frac1c\, \frac{\partial\vec{\mathbf{B}}}{\partial t} & = \vec{\mathbf{0}} \\
\nabla \cdot \vec{\mathbf{B}} & = 0
\end{array}$$
```
## Syntax
Math parsing in markdown is designed to agree with the conventions set by pandoc:
```
Anything between two $ characters will be treated as TeX math. The opening $ must
have a non-space character immediately to its right, while the closing $ must
have a non-space character immediately to its left, and must not be followed
immediately by a digit. Thus, $20,000 and $30,000 wont parse as math. If for some
reason you need to enclose text in literal $ characters, backslash-escape them and
they wont be treated as math delimiters.
```

View file

@ -0,0 +1,35 @@
If in List titles you like to create numbered text like this:
```
3. Something
```
Write it this way (to escape dot), so it shows correctly:
```
3\. Something
```
This happens because of markdown support for autonumbering in input fields.
For example, if you write numbered list like:
```
1. Something nice
1. Something cool
1. Something great
```
It will be autonumbered like this, so you can cut/paste reorder list freely, without manually reordering numbers:
```
1. Something nice
2. Something cool
3. Something great
```
For example, when you reorder numbered list like this:
```
1. Something great
1. Something nice
1. Something cool
```
It will show automatically numbered like this:
```
1. Something great
2. Something nice
3. Something cool
```

168
docs/Features/PWA.md Normal file
View file

@ -0,0 +1,168 @@
[Browser compatibility matrix](Browser-compatibility-matrix)
## Install your Wekan server as an app
- At below info, `Navigate to login page of Wekan` is your Wekan server, example https://wekan.yourcompany.com/sign-in
- App icon at Windows desktop, mobile etc
- App does not have webbrowser buttons like address bar
- Works in Wekan v4.02 and newer
### Windows desktop: Windows Chromium Edge
1. Open Chromium Edge.
2. Navigate to login page of Wekan
3. From Edge menu, install site as app, by clicking top right `⋮` and this menu, that can be used to install and manage/remove apps:
<img src="https://wekan.github.io/chromium-edge-install-pwa.png" width="60%" alt="Wekan logo" />
4. In next popup, give name to app, like `YourCompany Wekan`, and click `Add`
5. Now new app is in your Windows Start menu.
### iOS Safari
1. Open Safari.
2. Navigate to login page of Wekan.
3. At middle bottom click Share button that is box with arrow up.
4. Scroll down and click "Add to Home Screen" and "Add".
### Android Chrome
1. Open Chrome
2. Navigate to login page of Wekan.
3. Click top right menu `⋮` / Add to home screen.
4. Follow the onscreen instructions to install.
### Android Firefox (if that feature works and is not removed)
1. Open Firefox.
2. Navigate to login page of Wekan.
3. At right side of URL address, click button that has + inside of home icon.
4. Follow the onscreen instructions to install.
### Android Brave
1. Open Brave.
2. Navigate to login page of Wekan.
3. Click bottom right menu `⋮` / Add to home screen.
4. Follow the onscreen instructions to install.
### Android Opera
1. Open Opera.
2. Navigate to login page of Wekan.
3. Click top right menu `⋮` / Add to / Home screen.
4. Follow the onscreen instructions to install.
### Android Vivaldi
1. Open Vivaldi.
2. Navigate to login page of Wekan.
3. At right side of URL address, click [V] / Add to home screen.
4. Follow the onscreen instructions to install.
## Fullscreen Android app with Caddy and WeKan Server
These are mostly just notes to WeKan maintainer xet7 itself, how xet7 did get official WeKan Android Play Store app working at fullscreen of Android phone and Android tablet. Requires a lot time to setup, not recommended.
Related, for creating apps to other appstores: https://github.com/wekan/wekan/wiki/Browser-compatibility-matrix
1. https://www.pwabuilder.com to create Android app. Select fullscreen when creating app, also requires correctly installed assetlinks.json with below Caddy config to get fullscreen. When creating app, make your own signing key if you don't have one yet. Releasing Android app is at Play Console https://play.google.com/console/ .
2. PWABuilder has about 100+ downloadable icons etc webmanifest requirements like is at https://github.com/wekan/wekan/tree/main/public
3. Clone WeKan repo, add favicons etc from step 2 to wekan/public/ , and build WeKan bundle from source like at https://github.com/wekan/wekan/wiki/Emoji . Note: Currently WeKan does not have feature for custom favicons, it would require a lot of work for 100+ favicons etc customizations.
4. Run bundle at server like https://github.com/wekan/wekan/wiki/Offline or https://github.com/wekan/wekan/wiki/Raspberry-Pi
5. Install Caddy like https://github.com/wekan/wekan/wiki/Caddy-Webserver-Config , with this config for PWA at https://boards.example.com , there add assetlinks.json details you got when you downloaded Android .zip file from https://pwabuilder.com , see assetlinks issue about where at Play Console those 2 SHA256 keys https://github.com/pwa-builder/PWABuilder/issues/3867#issuecomment-1450826565
6. At Play Console https://play.google.com/console/ there is `App Integrity` button in the sidemenu (highlighted blue in the screenshot) where you find required 2 SHA256 keys for Caddyfile:
![image](https://user-images.githubusercontent.com/8823093/222261921-1afc64bd-6bcf-4ba1-9620-88572162746e.png)
7. Caddy uses tabs for indenting. At `/etc/caddy` you can also `caddy format > ca` to format output and forward to new file, and if it works then `mv ca Caddyfile` and validate it `caddy validate` and reload `caddy reload`. Sometimes update caddy with `caddy upgrade` and after that `caddy stop` and `caddy start`.
8. Also related is Parallel Snaps install to one server at encrypted VM at https://github.com/wekan/wekan-snap/wiki/Many-Snaps-on-LXC
9. In newest requirements installing assetlinks.json is to PWA URL (like https://boards.example.com), when it before was to main domain (like https://example.com), so here just in case it's installed to both, as text in `/etc/caddy/Caddyfile`. Also see https://docs.pwabuilder.com/#/builder/android
10. For figuring out Caddy 2 config, xet7 found related tips from Caddy forum https://caddy.community/t/well-known-file-location/16632/4
`/etc/caddy/Caddyfile`
```
# Redirecting http to https
(redirect) {
@http {
protocol http
}
redir @http https://{host}{uri}
}
example.com {
tls {
alpn http/1.1
}
header /.well-known/* Content-Type application/json
header /.well-known/* Access-Control-Allow-Origin *
respond /.well-known/assetlinks.json `[
{
"relation": ["delegate_permission/common.handle_all_urls"],
"target": {
"namespace": "android_app",
"package_name": "team.example.boards.twa",
"sha256_cert_fingerprints": [
"AA:AA... FIRST SHA256 KEY",
"61:41... 2nd SHA256 KEY"
]
}
}
]`
root * /data/websites/example.com
file_server
}
boards.example.com {
tls {
alpn http/1.1
}
header /.well-known/* Content-Type application/json
header /.well-known/* Access-Control-Allow-Origin *
respond /.well-known/assetlinks.json `[
{
"relation": ["delegate_permission/common.handle_all_urls"],
"target": {
"namespace": "android_app",
"package_name": "team.example.boards.twa",
"sha256_cert_fingerprints": [
"AA:AA... FIRST SHA256 KEY",
"61:41... 2nd SHA256 KEY"
]
}
}
]`
reverse_proxy 192.168.100.3:3025
}
```

View file

@ -0,0 +1,8 @@
## Planning Poker / Scrum Poker
Click Card => `☰` => `Edit Planning Poker`
- https://en.wikipedia.org/wiki/Planning_poker
- [Original Wekan Feature Request and Description](https://github.com/wekan/wekan/issues/3751)
- [Pull Request that implements Planning Poker](https://github.com/wekan/wekan/pull/3836)
- [Bug: Planning Poker Setting End Date only works in English](https://github.com/wekan/wekan/issues/3837)

15
docs/Features/Python.md Normal file
View file

@ -0,0 +1,15 @@
Some Python etc code in WeKan, that is not yet added directly to WeKan:
- [LDAP sync script, that also correctly removes users](https://github.com/wekan/wekan/blob/main/ldap-sync/ldap-sync.py)
- [Email notifications to AWS SES](https://github.com/wekan/wekan/issues/3543#issuecomment-1199897164)
- [Prometheus Exporter](https://github.com/wekan/wekan-prometheus-exporter)
- [Burndown Chart](Burndown-and-Velocity-Chart)
- [Scheduler](https://github.com/wekan/wekan-scheduler)
- [Cleanup](https://github.com/wekan/wekan-cleanup)
- [API client, most complete](https://github.com/wekan/python-wekan) (modelled after Trello API client)
- [API CLI](https://github.com/wekan/wekan/blob/main/api.py)
- [2nd API client](https://github.com/wekan/wekan-python-api-client)
- [Stats](https://github.com/wekan/wekan-stats)
- [Logstash and ElasticSearch](https://github.com/wekan/wekan-logstash)
- iCal server in [Python](https://github.com/wekan/wekan-ical-server) and [PHP](https://github.com/wekan/wekan-ical-php)
- [Sandstorm CSV related Python code](Wekan-Sandstorm-cards-to-CSV-using-Python)
- [Trello API test code](https://github.com/wekan/wekan/tree/main/trello)

14
docs/Features/Subtasks.md Normal file
View file

@ -0,0 +1,14 @@
## Fix: If you are unable to create Subtasks
This can happen on old boards: You have Subtasks board missing.
1) Create new board similar to your original board, but with `^` at beginning and end of your boardname. For example, if your boardname is `MyProject`, create new board with name `^MyProject^`. At keyboard that character is `Shift-^-Space`.
<img src="https://wekan.github.io/subtasks/subtask-workaround-part1.png" width="30%" alt="Subtask workaround part 1" />
2) Set your `MyProject` board to have subtask board `^MyProject^`
<img src="https://wekan.github.io/subtasks/subtask-workaround-part2.png" width="30%" alt="Subtask workaround part 2" />
3) Now you are able to create Subtasks to your board `MyProject`.

View file

@ -0,0 +1,15 @@
# Swimlanes are in Production!
Swimlanes divide a Kanban board into horizontal bands. Each lane can represent a person, group, or any other useful category for organizing and segmenting your cards.
## To Add Swimlanes
Click the **`Lists`** button (near the top right) to switch to the Swimlanes view. The **`Add Swimlane`** button is at far right of the lists. You may have to scroll horizontally to the right and minimize the righthand sidebar to see it.
## To Rename Swimlanes
You can change the name of a swimlane name by clicking the name. You may have to scroll all the way to the left, if your page is wider than the screen.
## To Reorder Swimlanes
You can reorder any swimlane by clicking (and holding) the name-area of the swimlane (on the left) and dragging it up or down into a new position.
## To Archive Swimlanes
You can archive any swimlane by clicking on the hamburger button (3 horizontal stacked lines). It is directly above the name of the swimlane on the left of the lane. You may have to scroll all the way to the left, if your page is wider than the screen.

View file

@ -0,0 +1,81 @@
[VIDEO ABOUT HOW TO USE BOARD TEMPLATES](https://www.youtube.com/watch?v=K0_cP85Bvas)
[More about templates explained here](https://github.com/wekan/wekan/issues/3127#issuecomment-634348524)
[Templates feature requests and bugs](https://github.com/wekan/wekan/issues?q=is%3Aissue+is%3Aopen+templates+label%3AFeature%3ATemplates)
***
There is currently:
- [Per-user templates](https://github.com/wekan/wekan/issues/2209), it works as described below.
- Card hamburger menu / Copy Checklist Template to Many Cards
At [Roadmap](https://boards.wekan.team/b/D2SzJKZDS4Z48yeQH/wekan-open-source-kanban-board-with-mit-license) of xet7, Maintainer of Wekan, these already have [some funding](https://wekan.team/commercial-support/):
- [Collapsible Swimlanes with count](https://github.com/wekan/wekan/issues/2804)
- [Single fixed list titles static at top of swimlanes view](https://github.com/wekan/wekan/issues/2805).
- [Main Boards/Organizing Boards/Nested Tabs](https://github.com/wekan/wekan/issues/2796) + [Shared templates](https://github.com/wekan/wekan/issues/2209) + [Top Level Projects](https://github.com/wekan/wekan/issues/641).
- [Teams/Organization Templates](https://github.com/wekan/wekan/issues/802).
- [Bug: Board templates aren't created automatically whenever the user was created by REST API or OAuth2](https://github.com/wekan/wekan/issues/2339).
These don't yet have [funding](https://wekan.team/commercial-support/):
- [Notification Email templates](https://github.com/wekan/wekan/issues/2148).
- [Email templates](https://github.com/wekan/wekan/issues/2022).
- [Import and Export Checklists](https://github.com/wekan/wekan/issues/904).
At Roadmap of some other Wekan Contributors:
- Prettify email notifications.
***
# Current Per-User Templates Feature
## 1) All Boards page, top right: Templates
### a) Create Card templates
1. Create a new list to Card Templates Swimlane
2. Add template cards to that new list.
### b) Create List templates
1. Create Lists to List Templates Swimlane
2. Add cards etc content to lists.
### c) Create Board Templates
1. Create List to Board Templates Swimlane.
2. Create Card to List that is at Board Templates Swimlane
3. Clicking black folder icon on that card goes to your new Board Template full screen view.
4. Add content to your Board Template
## 2) Insert new Cards/Lists/Boards from Templates
### a) Insert Card Templates
1. Go to some board.
2. Click Add Card. (Do not write card text).
3. Click Template.
5. Write new Title for template card you are planning to add.
4. Search for Template Card name or see that Template Card name is visible.
6. Click that Template Card.
7. Now Template Card is inserted with your new title.
### b) Insert List Templates
1. Go to some board.
2. At right edge or all lists, click Add List. (Do not add list name).
3. Click Template.
4. Write new Title for Template List you are planning to add.
5. Search for Template List Name or see if Template List Name is visible.
6. Click that Template List Name.
7. Now Template List is inserted with your new title.
### c) Insert Board Templates
1. Go to All Boards.
2. Click Add Board. (Do not add new board name).
3. Click Template.
4. Write new Title for Template Board you are planning to add.
5. Search for Template Board Name or see if Template Board Name is visible.
6. Click that Template Board Name.
7. Now Template Board is inserted with your new title.

View file

@ -0,0 +1,53 @@
# Description
When Wekan is loading big board, selected Wait Spinner animation is shown.
# Allowed Wait Spinners
[Source](https://github.com/wekan/wekan/blob/main/config/const.js#L52-L61)
Currently:
```
'Bounce',
'Cube',
'Cube-Grid',
'Dot',
'Double-Bounce',
'Rotateplane',
'Scaleout',
'Wave'
```
# Settings at Admin Panel
Admin Panel / Layout / Wait Spinner
# Source
```
export WAIT_SPINNER=Bounce
```
# Docker
```
- WAIT_SPINNER=Bounce
```
# Snap
```
sudo snap set wekan wait-spinner='Bounce'
sudo snap set wekan-gantt-gpl wait-spinner='Bounce'
```
# Non-English Translations, done at web only
https://app.transifex.com/wekan/
# Original English source
https://github.com/wekan/wekan/blob/main/i18n/en.i18n.json

View file

@ -0,0 +1,38 @@
UPDATE: Wekan now uses markdown-it and markdown-it-emoji plugin, see [Emoji page](Emoji)
## Numbered text
If in List titles you like to create numbered text like this:
```
3. Something
```
Write it this way (to escape dot), so it shows correctly:
```
3\. Something
```
***
Wekan uses GFM (Github Flavored Markdown).
We use the following project that ports GFM to meteor: https://github.com/wekan/markdown with updated newest markdown, that is fork of https://github.com/perak/markdown.
Newest Wekan uses newest markdown.
[Adding markdown to more places at Wekan progress](https://github.com/wekan/wekan/issues/2334)
[Related formatting tips for numbered lists](https://github.com/wekan/wekan/issues/2425)
**Note**: In order to use gfm checklist and other v0.28+ features, you need Wekan v2.61+.
[Checklist on markdown does not work yet](https://github.com/wekan/wekan/issues/2419)
## List of guides (from web archive):
* [Guide](https://guides.github.com/features/mastering-markdown/).
* [List of features](https://github.github.com/gfm/).
## Where can I use the markdown?
* Card name.
* Board name - Works on board view only.
* Card description, list and task list.