User Documentation

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

Well, I added back to Wekan website link to this community

And already moved wiki back to original location

yeah, I understand. but maybe someone from the community can take on that task one day. :)

good docs are quite important I think. but of course it takes time and effort, so I absolutely understand your prioritization. it was not meant as criticism. the work you do on this tool is amazing – thank you!

Thanks @kuchengrab :)

I have also rejected some website changes before https://github.com/wekan/wekan.github.io/issues/15#issuecomment-654428942

Wekan is not some big faceless corporation website

Actually, there has been problems with https://sandstorm.io website that it looks to pro and corporate, when it's actually a community effort

to => too

Hmm, I see your point. Of course it should not look like advertising or a corporation with dozens of employees. It's a fine line ... but I do like the sandstorm page, it's very clear communication in my opinion. I guess it's also a matter of where you're coming from. If you have some design background, you want everything to be more designed. If you are a hacker, you want every tool to be operable via CLI. It's quite subjective.