| Re: Modern documentation about general usage / People needed |
| by vamptrix on 2016/6/30 7:33:21 Mamba, could you add my user "kevinpetit" to the XOOPS organisation? |
| Re: Modern documentation about general usage / People needed |
| by vamptrix on 2016/6/27 15:20:25 Quote:
It looks like I lept to conclusions too soon - I have used Gitbooks before, but it didn't work as well back then. It look like it has improved quite a lot :) I take back all my problems with Gitbooks ;). |
| Re: Modern documentation about general usage / People needed |
| by Mamba on 2016/6/27 11:45:25 Quote: The big issue with GitBook is that it's a book: it's hard to search inside of it, and if you need information about something, it's hard to find it (unless you know how or where to find it/in which GitBook it is). It seems to me that you didn't spend any time of GitBook  Why are you saying that it's really to search inside of it???? What is wrong with the search inside a Gitbook? And if you want to link several GitBooks into one, you can do it as well. The process is the same everywhere else: a) you can have several small books, or b) you can create a one monster book Quote: And you can export it to HTML too. What do you mean by that??? The Gitbook is HTML as default: https://xoops.gitbooks.io/xoops-installation-guide/content/ |
| Re: Modern documentation about general usage / People needed |
| by vamptrix on 2016/6/27 10:48:15 Quote:
The big issue with GitBook is that it's a book: it's hard to search inside of it, and if you need information about something, it's hard to find it (unless you know how or where to find it/in which GitBook it is). GitBook is really good for specific information about 1 thing, like a module. But for general documentation, e.g. setting up your site, getting your rights set up and all basic XOOPS things, I think that a Sphinx documentation site would be better. Examples of Sphinx documentation are CodeIgniter, ReadTheDocs etc. It's really clean, fast and easy to maintain/edit. And you can export it to HTML too. And the search is really good too ;) |
| Re: Modern documentation about general usage / People needed |
| by Mamba on 2016/6/27 9:13:32 Thank you for your willingness to help with the documentation. Of course, we'll be glad to help with the documentation, but you need to start with it, so then we can see where we could help... And what's wrong with GitBook?  - One single, easy to read and write, Github rendered source format (i.e. Markdown) for different output formats such as HTML, PDF, MOBI, EPUB, - A documentation build is triggerable via Github Webhook, i.e. you can edit the documentation either with the GitBook Editor and it will upload the changes to GitHub, or you can make the changes on GitHub, and it will trigger rebuild of the book, so the readers will always have the latest and greatest version of the book, and you can choose whatever method you prefer to make changes. |
Search
Recent Posts
Who's Online
Donat-O-Meter
| Stats | |
| Goal: | $15.00 |
| Due Date: | Jul 31 |
| Gross Amount: | $0.00 |
| Net Balance: | $0.00 |
| Left to go: | $15.00 |
|
|