+- Cuberite Forum (https://forum.cuberite.org)
+-- Forum: Cuberite (https://forum.cuberite.org/forum-4.html)
+--- Forum: Development (https://forum.cuberite.org/forum-13.html)
+--- Thread: Writing a User Manual (/thread-1431.html)
RE: Writing a User Manual - bearbin - 04-10-2014
No, not a template engine. There is a template class built into python, no external libraries needed.
RE: Writing a User Manual - worktycho - 04-10-2014
So we're using the python template engine. Looks too minimalistic to me. Doesn't support include which is pretty much a required feature. Using python as much of an additional dependency as anything I mentioned.
RE: Writing a User Manual - bearbin - 04-10-2014
Python is not an "additional dependency"...
RE: Writing a User Manual - worktycho - 04-10-2014
Yes it is. We don't use it at the moment and you'd need it to generate the docs so its an additional requirement to generate the docs. None of my dev machines or VMs have it because I tend to use perl for this sort of thing. You can't assume that machines will have python, especially not windows.
RE: Writing a User Manual - gv1222 - 04-10-2014
Have you considered using Atlassian products? It is a paid software but as this is an opensource project you can get a free license (Supports unlimited users & full feature set). Confluence could be good for creating a wiki. https://www.atlassian.com
RE: Writing a User Manual - bearbin - 04-10-2014
We think we don't want a wiki, is that right?
RE: Writing a User Manual - gv1222 - 04-10-2014
I guess but using HTML, Python etc. to write the pages isn't really flexible, of course you can style the page however you like but when it comes to writing the documentation it's a lot more difficult to fix things on the fly and is also going to restrict anyone else from contributing isn't it? Just thought i'd throw my two cents in.
RE: Writing a User Manual - Narroo - 04-10-2014
(04-10-2014, 07:14 AM)gv1222 Wrote: I guess but using HTML, Python etc. to write the pages isn't really flexible, of course you can style the page however you like but when it comes to writing the documentation it's a lot more difficult to fix things on the fly and is also going to restrict anyone else from contributing isn't it? Just thought i'd throw my two cents in.
It wouldn't be Wiki style, so the only contributors would be people contributing to the repo. Or, am I missing something? I'm not familiar with HTML.
RE: Writing a User Manual - bearbin - 04-10-2014
Yeah, to contribute you would just fork and make a PR. Very easy, and better than a wiki in some ways (no user accounts, better style).
RE: Writing a User Manual - Narroo - 04-11-2014
Right. So how do we get the ball rolling on this?