User Documentation

@kuchengrab Anyone can send new documentation as markdown text added to new issue https://github.com/wekan/wekan . Some have tried to start creating more nicely formatted documention at https://github.com/wekan/wekanhow and https://github.com/wekan/wekan-doc , anyone is welcome to send pull requests to those docs. Currently I have my hands full of coding features and fixes mentioned at Roadmap, link to Roadmap at https://wekan.github.io . It would be very nice if anyone would contribute to docs and be part of such documentation team, currently there is no documentation team.

In general, I welcome all new contributors, that can send features, fixes, code etc as pull requests. At Wekan issues https://github.com/wekan/wekan/issues is currently 631 open issues. With current amount of contributors, some add new issues faster than current contributors can reply and fix them.

Having some new documentation contributors, that would add Wekan user and development documentation, would help new users and developers get up to speed faster.

I also welcome any info how I could better encourage new contributors to participate to development of Wekan

What happened to this, actually? https://wekandoc.readthedocs.io/en/latest/ Unfortunately the link to github is broken, seems like the user who started it has abandoned the project ... but looking at wekan-doc, it seems to be the same source. maybe it could be connected again somehow?

• wekanhow was quite confusing to me, maybe because there is nothing published yet, and I can't imagine yet how it comes together.
• I wanted to add a page to the github wiki, but I didn't find the md-code anywhere. maybe only official contributors can contribute to it?

git clone https://github.com/wekan/wekan.wiki.git

Yes, I did disable wiki editing by all logged in GitHub users, because some created new test wiki pages asking why they have edit permission.

Wiki docs are most up-to-date

At GitHub issues I have linked to wiki pages many times, and they are at top of search results

at Google search etc

Hmm, I'll look what kind of permissions wiki has

I made a wiki page. Unfortunately I could neither publish my branch nor make a pull requests via github. But maybe I'm too unfamiliar yet with using it properly ... it shows

Authentication failed. Some common reasons include:
- You are not logged in to your account: see File > Options.
- You may need to log out and log back in to refresh your token.
- You do not have permission to access this repository.
- The repository is archived on GitHub. Check the repository settings to confirm you are still permitted to push commits.
- If you use SSH authentication, check that your key is added to the ssh-agent and associated with your account.

@kuchengrab I moved Wekan wiki docs to https://github.com/wekan/wekan-doc/wiki and invited you to directly edit that wiki

You can directly edit with webbrowser

You can also clone it with: git clone [email protected]:wekan/wekan-doc.wiki.git

git add --all && git commit -m "Updated something" && git push

thanks @xet7 for adding me. I added my page both in the wiki and in the docs. unfortunately many of the links on the website linking to the old wiki location are now broken, though. The main task would be to do some bookbinding: to compile all the existing docs and make them accessible in one place. It's a nice task for non-programmer contributors – something that could be mentioned in "how to get involved". The aim would be to centralise the available information.

Problem

Right now, there are several places with partly redundant information:

• github readme-md (intro)
• wekan-github-io Website (intro)
• wekan-team (commercial support, but looks like second website)
• wekan-doc/wiki (official docs especially for admins and devs, in use, lots of information, not very structured)
• wekan-doc (docs: to do)
• wekanhow (docs based on GraphQL-howto: nice to have)

and then there is

• vanila.io forumvanila.io forum (general forum, bugs, feature requests)
• github wekan/issues (bugs, feature requests, and random people using github for the first time looking for help ...)

Goal

Ideally, all of these different spots (maybe there are even more?) should boil down to maybe three locations where wekan users, people interested in hosting a wekan instance, commercial support seekers, future contributors as well as experienced developers can find the information they are looking for. that would mean that all users (of different target groups) would find a central page with all important links in order to eliminate ambiguity. Questions like "*Shall I post my bug report in vanila or on github? is the wiki the official documentation or wekan-doc? What do I have to read before posting?" should not arise for users.

How to get there

I would propose:

• do some bookbinding of all the existing md-docs in wiki into the wekan-doc
• make wekan.team a sub-webpage of the main website
• archive incomplete projects like wekanhow
• separate use of different forums (e.g. vanila not for bugs/features) -- make it clear, where the Wekan community "lives", and where it communicates to the outside

(Unfortunately I don't have the time to do what I propsed, myself. And I know, @xet7 you want to dedicate your time to software development, commercial support and bugfixing. So maybe this could be done either by someone enthusiastic in the community ... or by a person who gets paid for it. I'm sure it would pay off, as the core team will have less support issues and FAQs to deal with every day!)

if you want, I can open an issue in github, so possibly more people can see this post, discuss it or, even better, DO. 🙂

Well, then I'll just move wiki back to original location

I already removed from Wekan website link to this community

I can not afford to pay anyone else for combining docs info

It's not that important

Question is, is having Wekan Open Source and free for commercial use enough for someone to spend their time contributing to Wekan docs etc