Re: [gnome-es] Gtranslator User Documentation in Mallard

For menu items that are not working properly, they can be documented as they are expected to work.  We have a <note style="bug"> tag, which can be added to state what the problem is and that the developers are working to resolve it.  Once the problem is fixed, the <note> would just need to be removed without the need to rewrite and docs :-)

2012/4/2 Daniel Mustieles García <daniel mustieles gmail com>
Great idea.

Note that, actually, there are some bugs that may affect you as documenter (i.e, some menu items not working properly), but I hope we will fix them in the hackfest.

BTW, don't worry about it, since it isn't a very big app. I can help you if you need something about it.


El 2 de abril de 2012 08:11, Radina Matic <radina matic gmail com> escribió:

Hi Daniel,

Thanks for your welcome, I'll definitely try to take part in the hackfest and do whatever I can - I'm not much of a coder :P

I'll check the contents of the available documentation and make a shared Google doc with a topic outline for the new version. This way we can all brainstorm about the contents for the time being, and I'll have an idea about the workload that the project will require when start working on it in June.


On Sat, Mar 31, 2012 at 10:48, Daniel Mustieles García <daniel mustieles gmail com> wrote:
Hi Radina,

First of all, many thanks for your interest in helping us to improve Gtranslator's documentation.

Actually, the documentation is really poor, and it's written in DockBook format, so we need to update it and migrate to Mallard; it isn't a very tricky app, so I think it will be relatively easy to to it.

About the Hackfest, you are welcome to participate :) You cand download Gtranslator from git and review the bug's list, so you can have and idea about what we need to fix. There are several "small" bugs that should be easy to fix. I'm planning add a "Brainstorm" section to the wiki, so participants can add their ideas for helping developers.

Thanks again and happy hacking :)


El 31 de marzo de 2012 07:31, Radina Matic <radina matic gmail com> escribió:
Hello everybody,

My name is Radina, I am collaborating with the
Getting Things GNOME! dev team and I am applying for the GOPW Internship this summer. My main project is going to be writing the user documentation for the Getting Things GNOME! app, but since it almost certainly will not take the whole 3 months of the internship duration, I was looking for additional tasks for the rest of the period. I am subscribed to your mailing list and was reading about your Gtranslator hackfest, when my future mentor Tiffany Antopolski mentioned that you were looking for someone to update the user documentation into Mallard, and all of it seemed like a perfect "gtiming"... :)

Considering the timeline of my GTG docs project, I will be able to actively start working on Gtranslator docs in Mallard  by the end of June at latest, but in the meantime I could participate in your hackfest activities and get to know the app itself better (I am translator myself, so I am fairly familiar with CAT tools). This might even be an advantage since you are working on some bugs and changes in the program itself, and hopefully they will be all dealt with before I start editing the user documentation.

Looking forward to hearing from you...


P.D.: Visto que toda la peña implicada en eso de Gtranslator parece ser de habla hispana, solo deciros que vivo en Barcelona y que conmigo no hace falta hablar en ingles... ;)


On Fri, Mar 30, 2012 at 16:49, Tiffany Antopolski <tiffany antopolski gmail com> wrote:
Hi Radina,


2. I am also very excited about the possibility of you also working on Gtranslator docs! :-)  I am forwarding correspondence between myself and Daniel Mustieles (A Gnome Spanish translator about this very topic just a few days ago.  I think your timing is perfect.)

3. I think gtg and Gtranslator docs are great projects.  Also, I personally am working on Tutorials for new developers just starting out, so perhaps, if you finish gtg and Gtranslator docs, maybe you would be able to edit these programming tutorials written in Mallard.  I was looking for someone with beginner knowledge for an editor, so would that be something you may be interested in (if time allows?).

Okay, best of luck with writing up your application :-), and here is the correspondence I mentioned with Daniel:

---------- Forwarded message ----------
From: Daniel Mustieles García <daniel mustieles gmail com>
Date: 2012/3/28
Subject: Re: Migrate Gtranslator's docs to Mallard
To: Nacho <nacho resa gmail com>
Cc: Tiffany Antopolski <tiffany antopolski gmail com>, Shaun McCance <shaunm gnome org>

I know, Ignacio. It is quite simple, but maybe our friends of the doc team could help us to improve it.

Reviewing it, I was going to remove some deprecated sections, but maybe it has no much sense if we are planning to upgrade it completely.

El 28 de marzo de 2012 12:18, Nacho <nacho resa gmail com> escribió:

Hey Daniel,

the documentation is short mainly because currently it sucks,
for an application like gtranslator we would need quite a long one ;)

2012/3/28 Daniel Mustieles García <daniel mustieles gmail com>
Hi Tiffanny and Shaun,

I'd like to migrate Gtranslator's documentation to Mallard, updating it, since it really out of date. I'd like to know if doc team could help us to do this, since I've no idea about how to do it.

Documentation is short, so it wouldn't be a hard work to review and update it.

Many thanks for your help :)

Ignacio Casal Quinteiro

Tiffany Antopolski

gnome-es-list mailing list
gnome-es-list gnome org

Tiffany Antopolski

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]