mirror of
https://github.com/wekan/wekan.git
synced 2025-12-30 14:18:48 +01:00
Reorganized Docs. In Progress.
This commit is contained in:
Lauri Ojansivu
parent
1961e22cbd
commit
ce89ff4833
202 changed files with 0 additions and 0 deletions
7
docs/Stats/Burndown-and-Velocity-Chart.md
Normal file
7
docs/Stats/Burndown-and-Velocity-Chart.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
[Discussion](https://github.com/wekan/wekan/discussions/4282)
|
||||
|
||||
WeKan Python Burndown Chart:
|
||||
- [Original](https://github.com/Gelmes/Wekan-Python-Burndown)
|
||||
- [WeKan fork](https://github.com/wekan/Wekan-Python-Burndown)
|
||||
|
||||
[WeKan Burndown Chart Chrome extension](https://chrome.google.com/webstore/detail/burndown-for-wekan/agdbocbobcbelnekjibocbilodjgopgh?)
|
||||
123
docs/Stats/Gantt.md
Normal file
123
docs/Stats/Gantt.md
Normal file
|
|
@ -0,0 +1,123 @@
|
|||
# What is this?
|
||||
|
||||
Original WeKan is MIT-licensed software.
|
||||
|
||||
This different Gantt version here currently uses Gantt chart component that has GPL license, so this Wekan Gantt version is GPL licensed.
|
||||
|
||||
Sometime later if that GPL licensed Gantt chart component will be changed to MIT licensed one, then that original MIT-licensed WeKan will get Gantt feature, and maybe this GPL version will be discontinued.
|
||||
|
||||
# How to use
|
||||
|
||||
[Source](https://github.com/wekan/wekan/issues/2870#issuecomment-721690105)
|
||||
|
||||
At cards, both Start and End dates should be set (not Due date) for the tasks to be displayed.
|
||||
|
||||
# Funding for more features?
|
||||
|
||||
You can fund development of more features of Gantt at https://wekan.team/commercial-support, like for example:
|
||||
- more of day/week/month/year views
|
||||
- drag etc
|
||||
|
||||
# Issue
|
||||
|
||||
https://github.com/wekan/wekan/issues/2870
|
||||
|
||||
# Install
|
||||
|
||||
Wekan GPLv2 Gantt version:
|
||||
- https://github.com/wekan/wekan-gantt-gpl
|
||||
- https://snapcraft.io/wekan-gantt-gpl
|
||||
- https://hub.docker.com/repository/docker/wekanteam/wekan-gantt-gpl
|
||||
- https://quay.io/wekan/wekan-gantt-gpl
|
||||
|
||||
## How to install Snap
|
||||
|
||||
[Like Snap install](https://github.com/wekan/wekan-snap/wiki/Install) but with commands like:
|
||||
```
|
||||
sudo snap install wekan-gantt-gpl
|
||||
|
||||
sudo snap set wekan-gantt-gpl root-url='http://localhost'
|
||||
|
||||
sudo snap set wekan-gantt-gpl port='80'
|
||||
```
|
||||
Stopping all:
|
||||
```
|
||||
sudo snap stop wekan-gantt-gpl
|
||||
```
|
||||
Stopping only some part:
|
||||
```
|
||||
sudo snap stop wekan-gantt-gpl.caddy
|
||||
|
||||
sudo snap stop wekan-gantt-gpl.mongodb
|
||||
|
||||
sudo snap stop wekan-gantt-gpl.wekan
|
||||
```
|
||||
|
||||
## Changing from Wekan to Wekan Gantt GPL
|
||||
|
||||
1) Install newest MongoDB to have also mongorestore available
|
||||
|
||||
2) Backup database and settings:
|
||||
```
|
||||
sudo snap stop wekan.wekan
|
||||
|
||||
mongodump --port 27019
|
||||
|
||||
snap get wekan > snap-set.sh
|
||||
|
||||
sudo snap remove wekan
|
||||
|
||||
sudo snap install wekan-gantt-gpl
|
||||
|
||||
sudo snap stop wekan-gantt-gpl.wekan
|
||||
|
||||
nano snap-set.sh
|
||||
```
|
||||
Then edit that textfile so all commands will be similar to this:
|
||||
```
|
||||
sudo snap set wekan-gantt-gpl root-url='https://example.com'
|
||||
```
|
||||
And run settings:
|
||||
```
|
||||
chmod +x snap-set.sh
|
||||
|
||||
./snap-set.sh
|
||||
|
||||
sudo snap start wekan-gantt-gpl.wekan
|
||||
```
|
||||
## Changing from Wekan Gantt GPL to Wekan
|
||||
|
||||
1) Install newest MongoDB to have also mongorestore available
|
||||
|
||||
2) Backup database and settings:
|
||||
```
|
||||
sudo snap stop wekan-gantt-gpl.wekan
|
||||
|
||||
mongodump --port 27019
|
||||
|
||||
snap get wekan-gantt-gpl > snap-set.sh
|
||||
|
||||
sudo snap remove wekan-gantt-gpl
|
||||
|
||||
sudo snap install wekan
|
||||
|
||||
sudo snap stop wekan.wekan
|
||||
|
||||
nano snap-set.sh
|
||||
```
|
||||
Then edit that textfile so all commands will be similar to this:
|
||||
```
|
||||
sudo snap set wekan root-url='https://example.com'
|
||||
```
|
||||
And run settings:
|
||||
```
|
||||
chmod +x snap-set.sh
|
||||
|
||||
./snap-set.sh
|
||||
|
||||
sudo snap start wekan.wekan
|
||||
```
|
||||
|
||||
# UCS
|
||||
|
||||
[Gantt feature at UCS](UCS#gantt)
|
||||
75
docs/Stats/Logs.md
Normal file
75
docs/Stats/Logs.md
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
Also see at this wiki right menu Webhooks:
|
||||
- Global Webhooks at Admin Panel, sends most board actions to webhook (chat, etc)
|
||||
- Per-board webhooks at Wekan board click hamburger menu => cog icon at right side of members => Board Settings / Webhooks, send actions of one board to some webhook
|
||||
|
||||
## Enable more Wekan debug logs:
|
||||
|
||||
a) Snap: `sudo snap set wekan debug='true'` - but also notice that [in Wekan v4.56 newer most mongo logs go to `/dev/null` on Snap](https://github.com/wekan/wekan/blob/main/CHANGELOG.md#v456-2020-11-30-wekan-release)
|
||||
|
||||
b) docker-compose.yml: `DEBUG=true`
|
||||
|
||||
c) start-wekan.sh: `DEBUG=true`
|
||||
|
||||
d) [MongoDB logs docs](https://docs.mongodb.com/manual/reference/log-messages/)
|
||||
|
||||
e) Logging all MongoDB queries, info [from StackOverflow](https://stackoverflow.com/questions/15204341/mongodb-logging-all-queries) below:
|
||||
```
|
||||
$ mongo
|
||||
MongoDB shell version: 2.4.9
|
||||
connecting to: test
|
||||
> use myDb
|
||||
switched to db myDb
|
||||
> db.getProfilingLevel()
|
||||
0
|
||||
> db.setProfilingLevel(2)
|
||||
{ "was" : 0, "slowms" : 1, "ok" : 1 }
|
||||
> db.getProfilingLevel()
|
||||
2
|
||||
> db.system.profile.find().pretty()
|
||||
```
|
||||
Source: http://docs.mongodb.org/manual/reference/method/db.setProfilingLevel/
|
||||
```
|
||||
db.setProfilingLevel(2) means "log all operations".
|
||||
```
|
||||
|
||||
## Wekan logs could be at syslog
|
||||
|
||||
Logs are at /var/log/syslog , like with:
|
||||
```
|
||||
sudo tail -f 1000 /var/log/syslog | less
|
||||
```
|
||||
|
||||
Or:
|
||||
|
||||
## Snap
|
||||
All:
|
||||
```
|
||||
sudo snap logs wekan
|
||||
```
|
||||
Partial:
|
||||
```
|
||||
sudo snap logs wekan.wekan
|
||||
|
||||
sudo snap logs wekan.mongodb
|
||||
|
||||
sudo snap logs wekan.caddy
|
||||
```
|
||||
## Docker
|
||||
|
||||
```
|
||||
docker logs wekan-app
|
||||
|
||||
docker logs wekan-db
|
||||
```
|
||||
## Sandstorm
|
||||
|
||||
When Wekan grain is open, click at top terminal icon, so then opens new window that shows logs
|
||||
|
||||
## Additional logs
|
||||
|
||||
- https://github.com/wekan/wekan-logstash
|
||||
- https://github.com/wekan/wekan-stats
|
||||
- Boards count https://github.com/wekan/wekan/pull/3556
|
||||
- At this wiki right menu, also look at Webhooks topic
|
||||
- https://github.com/wekan/wekan/wiki/Features#Stats
|
||||
- https://github.com/wekan/wekan/issues/1001
|
||||
83
docs/Stats/Mermaid-Diagram.md
Normal file
83
docs/Stats/Mermaid-Diagram.md
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
## DOES NOT WORK ANYMORE
|
||||
|
||||
https://github.com/wekan/wekan/issues/4841
|
||||
|
||||
As of newest Mermaid 10.0.0, Mermaid does not work in WeKan anymore, so Mermaid was removed in WeKan v6.76. xet7 did maintain https://www.npmjs.com/package/@wekanteam/markdown-it-mermaid but after updating to Mermaid 10.0.0 using Mermaid on WeKan card description etc did not work anymore.
|
||||
|
||||
## Source
|
||||
|
||||
- [Original issue, please comment there if Mermaid is useful](https://github.com/wekan/wekan/issues/3794).
|
||||
- [Original commit](https://github.com/wekan/wekan/commit/5ab20a925763a3af941c42d1943da9c8bb8852bd)
|
||||
|
||||
## Npm package
|
||||
|
||||
- NPM package at https://www.npmjs.com/package/@liradb2000/markdown-it-mermaid
|
||||
|
||||
## About examples
|
||||
|
||||
- Below examples and more at https://mermaid-js.github.io/mermaid/#/examples
|
||||
- https://jessems.com/posts/2023-07-22-the-unreasonable-effectiveness-of-sequence-diagrams-in-mermaidjs
|
||||
- https://news.ycombinator.com/item?id=36845714
|
||||
|
||||
## Howto
|
||||
|
||||
- Add mermaid code to Wekan card or any other input field. After some time, if chart is not visible, reload browser webpage.
|
||||
- Mermaid code starts with `~~~mermaid`
|
||||
- Mermaid code ends with `~~~`
|
||||
|
||||
## Example 1: Flowchart
|
||||
|
||||
```
|
||||
~~~mermaid
|
||||
graph TD
|
||||
A[Client] --> B[Load Balancer]
|
||||
B --> C[Server01]
|
||||
B --> D[Server02]
|
||||
~~~
|
||||
```
|
||||
|
||||
## Example 2: Pie Chart
|
||||
|
||||
```
|
||||
~~~mermaid
|
||||
pie title NETFLIX
|
||||
"Time spent looking for movie" : 90
|
||||
"Time spent watching it" : 10
|
||||
~~~
|
||||
```
|
||||
|
||||
## Example 3: Gantt Chart
|
||||
|
||||
```
|
||||
~~~mermaid
|
||||
gantt
|
||||
dateFormat YYYY-MM-DD
|
||||
title Adding GANTT diagram functionality to mermaid
|
||||
excludes weekends
|
||||
%% (`excludes` accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".)
|
||||
|
||||
section A section
|
||||
Completed task :done, des1, 2014-01-06,2014-01-08
|
||||
Active task :active, des2, 2014-01-09, 3d
|
||||
Future task : des3, after des2, 5d
|
||||
Future task2 : des4, after des3, 5d
|
||||
|
||||
section Critical tasks
|
||||
Completed task in the critical line :crit, done, 2014-01-06,24h
|
||||
Implement parser and jison :crit, done, after des1, 2d
|
||||
Create tests for parser :crit, active, 3d
|
||||
Future task in critical line :crit, 5d
|
||||
Create tests for renderer :2d
|
||||
Add to mermaid :1d
|
||||
|
||||
section Documentation
|
||||
Describe gantt syntax :active, a1, after des1, 3d
|
||||
Add gantt diagram to demo page :after a1 , 20h
|
||||
Add another diagram to demo page :doc1, after a1 , 48h
|
||||
|
||||
section Last section
|
||||
Describe gantt syntax :after doc1, 3d
|
||||
Add gantt diagram to demo page :20h
|
||||
Add another diagram to demo page :48h
|
||||
~~~
|
||||
```
|
||||
18
docs/Stats/Metrics.md
Normal file
18
docs/Stats/Metrics.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
## 1) Matomo
|
||||
|
||||
https://github.com/wekan/wekan-snap/wiki/Supported-settings-keys#matomo-web-analytics-integration
|
||||
|
||||
## 2) Metrics
|
||||
|
||||
- [Original PR](https://github.com/wekan/wekan/pull/4700). Thanks to Emile840.
|
||||
- [Fix typos and translate comments to English](https://github.com/wekan/wekan/commit/551f57b03bbc1dba37862a0cc3407c8d359e2a9a). Thanks to xet7.
|
||||
- [Added METRICS_ALLOWED_IP_ADDRESSES settings to Docker/Snap/Source](https://github.com/wekan/wekan/commit/34862810df686abfc0ee9ff1a13690a7b2bacc7e) and missing Matomo settings to Snap help. Thanks to xet7.
|
||||
|
||||
### Docker
|
||||
|
||||
[docker-compose.yml](https://raw.githubusercontent.com/wekan/wekan/master/docker-compose.yml)
|
||||
```
|
||||
- METRICS_ALLOWED_IP_ADDRESSES=192.168.0.100,192.168.0.200
|
||||
```
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue