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
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!!!