xoops forums

Mamba

Moderator
Posted on: 2014/12/2 22:29
Mamba
Mamba (Show more)
Moderator
Posts: 10819
Since: 2004/4/23
#1

XOOPS standardizes its Documentation on GitBook Platform

Resized Image


We are happy to announce that going forward XOOPS is standardizing its all Documentation on the GitBook Platform

As you can see above, we have already converted several of our documents to GitBook, and there will be more coming

In the meantime please go to our GitBook Repository, check it out, and let us know what you think.

Why GitBook?

GitBook is a tool for building beautiful books using Markdown syntax. It can generate your book in multiple formats: PDF, ePub, mobi or as a Website. By leveraging GitHub, it provides the best collaboration tool for developers and documentation writers to work together, and with an excellent Versioning system as a foundation.

The biggest advantage for Open Source projects such as XOOPS, is that everybody can contribute to the documentation by simply forking the document and submitting changes back to the team.

Another advantage of GitBook is the option to have multi-lingual versions in one single repository, with users being able to select their own language. Since XOOPS is a very international project, this is very important to us.

Some of the key features:

Version Control, GitBook is based on GIT scm. A simple "git push" is enough to publish a new version.

Markdown, books are written using the markdown syntax. Asciidoc and TeX support is planned.

Simple to update, publish and update your books easily using Git or the editor.

Responsive, books can be read on all devices, laptops, tablets, phones, kindles, etc.

E-book readers, books are readable on the Amazon Kindle, Nook and other readers (PDF, ePub, Mobi).

GitHub, write your book on GitHub and publish it in seconds through GitBook.

Choose your price, or accept donations, from $0 (or free) to $100.

Communicate, update and engage your readers with the progress of your work.


This is a very exciting for us, because we know that while XOOPS was always known for a very good code and great modular architecture, we were never able to create good documentation.

We believe that thanks to GitBook we have now found a tool that will help us to:

a) streamline the documentation process and make it more efficient

b) engage the community by leveraging the same "forking and submitting pull requests" process as they are already using at their normal coding activities.


For the people who would like to help us:


1) We have documented the XOOPS Documentation Process, so please review it and let us know if it works for you

2) We have created a "XOOPS Docs Starter Kit" with a predefined folder and file structure, that you can use to jump-start your project

We hope that once you realize how easy it is to contribute, you'll help us to make XOOPS Documentation really shine!!!

Viva XOOPS!
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

timgno

Module Developer
Posted on: 2014/12/3 15:57
timgno
timgno (Show more)
Module Developer
Posts: 1504
Since: 2007/6/21
#2

Re: XOOPS standardizes its Documentation on GitBook Platform

Nice!

Great Job

Mamba

Moderator
Posted on: 2014/12/3 17:43
Mamba
Mamba (Show more)
Moderator
Posts: 10819
Since: 2004/4/23
#3

Re: XOOPS standardizes its Documentation on GitBook Platform

The question is: who can help us in writing more Tutorials? Or any other documentation for XOOPS?
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

redheadedrod

Home away from home
Posted on: 2014/12/4 9:39
redheadedrod
redheadedrod (Show more)
Home away from home
Posts: 1296
Since: 2008/2/26
#4

Re: XOOPS standardizes its Documentation on GitBook Platform

Very cool... Will have to check it out.. I think I have some documents around here that could use some modification and uploading.. After finals I will have to play with it a little.

Rodney

Mamba

Moderator
Posted on: 2015/5/26 10:07
Mamba
Mamba (Show more)
Moderator
Posts: 10819
Since: 2004/4/23
#5

Re: XOOPS standardizes its Documentation on GitBook Platform

I have set few new tutorials, and we need some help with it!

Who can help?

You don't need to be a programmer, just a user of that module. Or somebody who can take the module, play with it, and then write a tutorial on how to use it.

Our Documentation Process is described in this document. You basically fork the tutorial from our XoopsDocs repository on GitHub, set up an account on GitBook, and you can start working on the documentation.

You can view the the tutorials in a "book format" on our GitBook Account

The new tutorials where we need help are here:

Publisher Module
NewBB Module
WF-Downloads Module
XoopsTube Module
XOOPS Partners Module
extGallery Module
extCal Module
Tag Module

I have also added some tutorials from our older modules:

Repair-Shop Module
xHelp Module
xAsset Module
XOOPS Debugging with FireBug and FirePHP

XOOPS 2.5.7 Cookbook for Webmasters


And I've created placeholders for XOOPS 2.6.0 tutorials

XOOPS 2.6.0 Assets Management
XOOPS 2.6.0 Service Manager
XOOPS 2.6.0 Codex

So we have now:

- Documentation Process,
- tools like GitHub and GitBook, and
- placeholders for the documents

The only thing that we need is volunteers who can fork and start working on them.

Who will be the first one?
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

Mamba

Moderator
Posted on: 2015/9/30 10:33
Mamba
Mamba (Show more)
Moderator
Posts: 10819
Since: 2004/4/23
#6

Re: XOOPS standardizes its Documentation on GitBook Platform

Resized Image


I've added few more Tutorial books that will need help in updating:

1) Alumni-tutorial

2) amReviews-tutorial

3) Backup-tutorial

4) News-tutorial

5) gWiki-tutorial

6) Jobs-tutorial

7) rwBanner-tutorial

8) Soapbox-tutorial

9) XOOPS Cookbook for Webmasters
(How to start a new Website using XOOPS in 1 hour, & learn how to master it in 7 days?

10) Buildi­ng XOO­PS Mod­ule (T­utoria­l by K­aotik)

11) xNewsletter Tutorial


You can preview all these books on XOOPS GitBook Repository

And once you there, please don't forget to give every XOOPS book a star, as it makes these books more visible!

But we NEED YOUR HELP to update and finish these Tutorials!!!

Again, you don't have to be a programmer to do it! You could be a current user, or somebody who would like to learn how to use that particular module, and would write down his notes as he is learning.

Or you can donate money for a particular Tutorial for somebody else to write it. You would become a sponsor of that Tutorial!
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

Dante7237

Friend of XOOPS
Posted on: 2015/9/30 14:57
Dante7237
Dante7237 (Show more)
Friend of XOOPS
Posts: 288
Since: 2008/5/28
#7

Re: XOOPS standardizes its Documentation on GitBook Platform

I should probably get around to reading these darnit. :)

Dante7237

Friend of XOOPS
Posted on: 2015/9/30 14:59
Dante7237
Dante7237 (Show more)
Friend of XOOPS
Posts: 288
Since: 2008/5/28
#8

Re: XOOPS standardizes its Documentation on GitBook Platform

In the years I've had exp with XOOPS, xHelp has never been a functional module.
I don't see a need for inclusion.

Mamba

Moderator
Posted on: 2015/9/30 16:11
Mamba
Mamba (Show more)
Moderator
Posts: 10819
Since: 2004/4/23
#9

Re: XOOPS standardizes its Documentation on GitBook Platform

Quote:
In the years I've had exp with XOOPS, xHelp has never been a functional module.
I don't see a need for inclusion.

Maybe somebody will take a look and improve it?

The module has some very good ideas, and with some refactoring I could see it as a potentially useful module for somebody.
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

Mamba

Moderator
Posted on: 2015/10/3 22:06
Mamba
Mamba (Show more)
Moderator
Posts: 10819
Since: 2004/4/23
#10

Re: XOOPS standardizes its Documentation on GitBook Platform

Goffy did a great job documenting the xNewsletter module that he created!

Thank you Goffy!!!

You can view it on GitBook

And you can fork this Tutorial and improve it on GitHub
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs