You are not logged in.
- Topics: Active | Unanswered
#1 2011-03-20 20:45:42
Should we use git to publish bug correction, translations... ?
Hi,
Now that Ionize is on GitHub, should developers not members of the Ionize team use git to commit the bug corrections, new translations to see them appear in next releases or in the main repository... ?
I will have to make a french documentation for my customers on how to use Ionize's admin, I guess it might be useful to others, any advice on that ? Is the current html user-guide done using some kind of generation tool ?
Well, please give some guidelines on how you expect the community to act 
Regards,
Pascal
Offline
#2 2011-03-22 15:16:06
- Michel-Ange
- Ionize Core Team
- From: Paris, France
- Registered: 2010-03-22
- Posts: 713
- Website
Re: Should we use git to publish bug correction, translations... ?
Hypee : A french documentation will of course be a great thing ! I enjoy !
The current documentation is hand made, inspired form the CodeIgniter one.
We just migrate to gitHub and we need to think about the opportunity to use gitHub to provide read/write access to some repositories and / or wikis, so the community can upload translation packages and translated documentation also.
But you're right, we're not precise enough about who can do what and how to act. We will think about and give our detailled point of view.
Inspiration & Innovation : Websites by Partikule, Agence Web Paris
Offline
#3 2011-03-23 15:54:08
Re: Should we use git to publish bug correction, translations... ?
I started to make the french translation of the user guide using the "hand made" way with static html pages.
After doing a couple of pages, I realized how insane it will be to make that work and then to update it when changes will eventually happen in the english version.
So after some thinking, I decided to set up a Ionize website to store the current english documentation and do the french localization. I thought it will also be a better way to allow other contributors to make translations in their own languages.
I tried to stay as close as possible from the current version.
The functionalities are not finished (search engine, navigation) but all english pages are now in the Ionize engine and I'm starting to write the french version.
You can see the result on http://ionizedoc.hypee.com
I will send you the sources & database if you like it & want to use it/host it on the Ionize website.
If you want to use it but still want to provide an html version, I can see if I can generate static content and/or .pdf from the database.
If you don't like the idea, I will host an "unofficial" version of the documentation & update it when you will publish "official" modifications to the english version.
Tell me your thoughts.
Regards,
Pascal
Offline
#4 2011-04-01 13:02:47
- Michel-Ange
- Ionize Core Team
- From: Paris, France
- Registered: 2010-03-22
- Posts: 713
- Website
Re: Should we use git to publish bug correction, translations... ?
Hi Pascal,
I had a look at you doc : Very nice, I love it !
What you done is very good and I can just say : "Bravo" !
We thought about "ionizing" the doc, but everytime came the same question : "What about the offline version ?"
Then we thought about your suggestion, auto-generation of offline version. Of course that could be a really great thing, to be able to download the last doc in full HTML in the choosen language.
Perhaps by developping a module or through a dedicated controller ?
Concerning the offline format, I think HTML is the better one. Nobody reads PDF. It's just boring.
I'm open to you suggestion concerning the HTML generation. Do you already thought to a way ?
Last edited by Michel-Ange (2011-04-01 13:05:22)
Inspiration & Innovation : Websites by Partikule, Agence Web Paris
Offline