Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation on team projects #725

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Kazephil
Copy link
Contributor

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.

</listitem>
</varlistentry>
<varlistentry>
<term>Checking project statistics</term>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why ? How ? Even if it is outside the scope of OmegaT, maybe clarifying a bit could help?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that necessary ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which part? The file types, or the part about the project managers looking at the statistics and automating their processing?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

@brandelune brandelune left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a few comments.

@Kazephil
Copy link
Contributor Author

I left a few comments.

Thanks. I'll need a few days to go through them.

@miurahr
Copy link
Member

miurahr commented Sep 28, 2023

@Kazephil any progress?

@Kazephil
Copy link
Contributor Author

@Kazephil any progress?

@miurahr
Unfortunately not. My originally reasonable schedule turned into a few weeks from hell due to urgent work coming in. My schedule is still full until the middle of the week.

Keeping my fingers crossed after that...

@miurahr
Copy link
Member

miurahr commented Nov 5, 2023

Any progress in 5 weeks?

@Kazephil Kazephil marked this pull request as draft November 6, 2023 00:35
@miurahr
Copy link
Member

miurahr commented Jan 16, 2024

Any progress in 2 months? @Kazephil

Could you give a direct contribution on changes? @brandelune

@brandelune
Copy link

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.

@Kazephil
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants