Update documentation on team projects #725
Conversation
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term>Checking project statistics</term> |
There was a problem hiding this comment.
Why "checking" and not "Consulting"?
| <varlistentry> | ||
| <term>Checking project statistics</term> | ||
| <listitem> | ||
| <para>This only applies to workflows that ask translators to commit the translated |
There was a problem hiding this comment.
Because that's essentially the way the feature request and the implementation work. Statistics are only committed when target files are committed.
I'll have to expand on that more, though. Maybe add a short section on the difference between managing projects as:
- one of the translators involved, with a copy of the project on their system
- purely a coordinator not involved in the actual translating, and working directly with the repository and without a copy of the OmegaT project on their system.
| target files to the repository as deliverables.</para> | ||
| <para>When OmegaT commits the target files, it also commits the project statistics | ||
| in <filename>.txt</filename> and <filename>.json</filename> format. This enable the | ||
| project manager to consult the statistics, and possibly automate their processing, |
There was a problem hiding this comment.
Why ? How ? Even if it is outside the scope of OmegaT, maybe clarifying a bit could help?
There was a problem hiding this comment.
You're right. I haven't had as much time as I'd like, but I'll try to rework the section to expand and clarify on things sometime over the next week.
| <para>When OmegaT commits the target files, it also commits the project statistics | ||
| in <filename>.txt</filename> and <filename>.json</filename> format. This enable the | ||
| project manager to consult the statistics, and possibly automate their processing, | ||
| without the need to open OmegaT.</para> |
There was a problem hiding this comment.
Which part? The file types, or the part about the project managers looking at the statistics and automating their processing?
There was a problem hiding this comment.
The second part. I think burying a possible use at the end of a sentence is the best way to never have it used. Maybe having a small section about automatic processing of OmegaT data in the stats and linking to this section is best.
Thanks. I'll need a few days to go through them. |
|
@Kazephil any progress? |
|
Any progress in 5 weeks? |
|
Any progress in 2 months? @Kazephil Could you give a direct contribution on changes? @brandelune |
I can work on it this week-end. @Kazephil if you have ideas, go ahead. |
|
There have been a number of questions about team projects in the Telegram group and on the mailing list(s?) that suggest the manual isn't clear enough, and I've been thinking about how best to address them. I'll try to compile of list of points to address and propose a new outline for the team project chapters over the weekend, and go from there. |
Which ticket is resolved?
#412 Document "Have "Commit Target Files" also commit statistics file:
https://sourceforge.net/p/omegat/documentation/412/
Specifically:
Add information about commiting statisitics files when target files are comitted.
Add information on managing a team project in the How to set up a team project chapter.
Standardize inconsistent uses of "project administrator" and "project manager" to just "project manager".
Let me know if there are any project management/maintenance tasks missing from the new section on managing a team project.