Page 1 of 1

Make documentation less confusing

PostPosted: Fri May 10, 2019 10:20 am
by wolgade
Well, so I decided to switch to Python3. I wanted to use the source code. This was harder than I thought due to outdated, misleading, missing or hard-to-find documentation.

The most obvious road to follow is a very recent post by Joel (http://www.makehumancommunity.org/forum/viewtopic.php?f=9&t=12448), but this will give you the deprecated source code (Bitbucket) without telling you. EDIT: I finally realized that this posting is rather old, so Joel is not to blame. Anyway a good reason to update this thread.

My next attempt was to look at http://www.makehumancommunity.org/wiki/Releases. The pages dealing with 1.2.0 contained a subsection called "running from source" without telling you where to get the source. I edited these pages. Now they do.

I finally found what I was looking for at http://www.makehumancommunity.org/content/downloads.html, but at the wrong place. The link to Github is in the section "stable version", which is simply wrong. You still find the stable version on Bitbucket. Github will give you Python3.

Re: Make documentation less confusing

PostPosted: Fri May 10, 2019 10:59 am
by wolgade

Re: Make documentation less confusing

PostPosted: Fri May 10, 2019 11:02 am
by joepal
Help updating the wiki is very, very welcome.

Did you manage to solve it in the end?

Re: Make documentation less confusing

PostPosted: Fri May 10, 2019 11:05 am
by wolgade
joepal wrote:Did you manage to solve it in the end?

Sure! :D But I took notes on any problem I had with the intention to clarify documentation.

Re: Make documentation less confusing

PostPosted: Fri May 10, 2019 12:50 pm
by RobBaer
Thanks for all your help and contributions. The community is stronger for members like you.

Re: Make documentation less confusing

PostPosted: Sat May 11, 2019 7:22 pm
by punkduck
wolgade wrote:Sure! :D But I took notes on any problem I had with the intention to clarify documentation.


Great Wolgade ;) Coders like me have two main problems:

  • we are often too lazy to write a good documentation. And I am not only speaking about the forum. Ask the guys where I work :mrgreen:
  • some things simply work ... we don't know why or we forgot ... please don't ask us. In program code we mark these spots with our signs ... a typical one is: #TODO and sometimes, more realistic #WTF :lol:

So yes, we appreciate this help. Since we both are in contact for more than a year, you know that about me ;)

Re: Make documentation less confusing

PostPosted: Sat May 11, 2019 11:28 pm
by loki1950
It's not so much laziness as the team leader handing you your next six assignments to add to your already full to do list :shock:

Enjoy the Choice :)