User Documentation

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.

More designed is better, if it's an improvement in some way. And still different not exactly same as in some other website.

Changing URLs to break links is not an improvement

that's for sure :D

As a new user I did find the documentation a bit hard to navigate when compared to other projects. Having threads and pathes of info here and there didn't help really.

I think the best bang for your buck would be creating some solid installation instructions for docker etc. Reducing the friction of install will help the community grow and help the project gain more traction. (I found a quite a bit, )

I found quite a few rapit trails when installing Wekan on docker-compose. I had to piece together info from out dated tutorials, broken github links and then had to further research to find out how to create my first user. It

I keep bumbing the enter button >_<

It could have taken 15 minutes from start to finish, but it took more like 2 hours because the documentation was confusing.

You're rest API documentation is fantastic though! Once I was up and running I got going in no time!

Only issue I had was with login. Docs say <token> but in actual fact it's "Bearer <TOKEN>" . If there was a quick not about that I could have saved 2 hours of frustration.

Huh? Newest docker-compose.yml is at https://github.com/wekan/wekan and works with docker-compose up -d for local user without any changes

https://github.com/wekan/wekan/wiki/Adding-users

It's just that I don't know what is confusing and what would be better. I'm too close to Wekan and know Wekan docs too well to understand how to improve it. Some outsider like you will see it much better.

Problem is not getting community to grow, it already grows all the time. Problem is getting amount of documentation and code contributions to grow.

Although, with new Wekan releases happening every day, with new features and fixes, it's kind of a lot already.

I know! so simple... not sure why it took so long. I've setup many dozens of complex services so I don't think it was on my end. I'll try to plot/map my experience to shed some light on the new comers experience. I might write what I would consider an easy to follow install tutorial for consideration.

My experience:

1. found Wekan (yay) and scanned rest docs at https://wekan.github.io/api/v4.81/#wekan-rest-api
2. Looked for install instructions at https://github.com/wekan/wekan/wiki/Developer-Documentation (bit dumb I know but this was the first reference to docs I saw)
3. Got redirected form the home page here. https://github.com/wekan/wekan/wiki/Platforms - Got confused if docker-compose was viable, still didn't see instructions how to start it.
4. Briefly looked at starting my own MangoDb server as I thought I had to do that separately.
5. tried following instructions here https://github.com/wekan/wekan/wiki/AWS but the docker-compose.yml link was broken. https://github.com/wekan/wekan-mongodb
6. eventually found the compose file in the main git-hub repo tentatively used that instead hoping it would work.
7. Googled around for ages looking for default name and password as https://github.com/wekan/wekan/wiki/AWS has no links to the "Add-User" documentation and I wasn't clever enough to find it on my own.
8. setup an account, and recieved the apparent expected 501 error so assumed it wasn't working.
9. found this tutorial hoping it would include something relating to default passwords/users https://www.howtoforge.com/tutorial/ubuntu-wekan-installation/ managed to get it working, unsure if the manual db manipulation was really important or not.
10. was happy to get wekan working! but it was late by now so had to wait till the next day to test out it's features.

Before I started with Wekan I tried Retya. There install process was arguably more complicated, but way easier due to their bouncing ball style documentation.

https://restya.com/board/docs/ - Easy to navigate documentation https://restya.com/board/docs/install-restyaboard-docker/#0 - Super simple install steps.

I suppose being a commercial company they can pay someone to look after documentation, but it is a good example for us.

I think a tutorial style getting started/installed workflow/document would be great. Make it impossible to miss on the git-hub home page. It need to cover or at least link to everything from docker-compose.yml to login and even creating your first board.