Bug 41909 - Developer reference: Chapter 11 needs changes to reflect modified tooling.
Developer reference: Chapter 11 needs changes to reflect modified tooling.
Status: CLOSED FIXED
Product: UCS extended documentation
Classification: Unclassified
Component: Developer documentation
unspecified
Other Linux
: P5 normal (vote)
: UCS 4.1-3-errata
Assigned To: Eduard Mai
Alexander Kläser
:
: 41912 (view as bug list)
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2016-08-03 16:43 CEST by Eduard Mai
Modified: 2016-10-10 16:48 CEST (History)
3 users (show)

See Also:
What kind of report is it?: Bug Report
What type of bug is this?: 2: Improvement: Would be a product improvement
Who will be affected by this bug?: 1: Will affect a very few installed domains
How will those affected feel about the bug?: 1: Nuisance – not a big deal but noticeable
User Pain: 0.011
Enterprise Customer affected?:
School Customer affected?:
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Max CVSS v3 score:
mai: Patch_Available+


Attachments
Patch for documentation in ucs-4.1-2 branch (7.52 KB, patch)
2016-08-03 16:43 CEST, Eduard Mai
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Eduard Mai univentionstaff 2016-08-03 16:43:40 CEST
Created attachment 7850 [details]
Patch for documentation in ucs-4.1-2 branch

As the tools described in Chapter 11 of the developer reference changed via Bug 41223, changes to this chapter are needed.

A proposal is attached as a patch.
Comment 1 Eduard Mai univentionstaff 2016-08-04 12:54:30 CEST
*** Bug 41912 has been marked as a duplicate of this bug. ***
Comment 2 Philipp Hahn univentionstaff 2016-08-17 08:58:30 CEST
r71670 | Bug #41909 devdoc: Update translation process

TODO: merge into 4.2 after QA.
Comment 3 Alexander Kläser univentionstaff 2016-09-05 14:45:25 CEST
Looks really nice. Some minor suggestions:
* Split 1. and 2. in 11.1.1. into two separate subsections (11.1.1 and 11.1.2.), 
  that would feel more smooth, IMHO.
* 11.1.2.: "... translation package for e.g. French ..." → "for, e.g., French"
* Could you replace the "tabs" in the code samples with spaces? My bash will try
  to auto-complete when copy 'n' paste :/
* 11.1.3.: "... are located below the directory fr/." → "directory ~/translation
  /univention-ucs-translation-fr/fr" would be a bit clearer, here
* 11.1.3.: You can remove the .html files from the manual, they are obsolete.
* 11.1.4.: It would be nice to give a hint to "svn up" for updating the SVN repo
* 11.1.4.:
"Following example will update a translation package univention-ucs-translation-fr/ using an updated Subversion checkout in ucs-4.1-3/:"
→
"The following example will update the translation package univention-ucs-translation-fr/:"
... otherwise there would be too many references to SVN, I feel.

My package build fails as it tries to build an example UMC module in the doc folder:
> ./doc/developer-reference/umc/ucr/debian/univention-management-console-module-ucr.umc-modules
> Found package: ./doc/developer-reference/umc/ucr

This leads to a build error:
> make[1]: *** Keine Regel vorhanden, um das Target »fr/doc/developer-reference/umc/ucr/umc/js/fr.po«, 
>   benötigt von »/root/translation/univention-ucs-translation-fr/debian/univention-ucs-translation-fr/usr/share/univention-management-console-frontend/js/umc/modules/i18n/fr/ucr.json«, zu erstellen.  Schluss.
Comment 4 Eduard Mai univentionstaff 2016-09-06 19:42:20 CEST
ucs-4.1-3:
Rev. 72333: Adds changes proposed in comment 3.

TODO: merge into 4.2
Comment 5 Alexander Kläser univentionstaff 2016-09-07 11:11:09 CEST
* 11.1.4.: "There are two file formats in common use:" → is obsolete as there is 
  just the .po file format being described.
* 11.1.3.: "This creates a new directory ..., which contains..." → no "," in 
  English at this point.

Otherwise, changes look fine :) .
Comment 6 Eduard Mai univentionstaff 2016-09-07 13:35:01 CEST
r72361 | (In reply to Alexander Kläser from comment #5)
> * 11.1.4.: "There are two file formats in common use:" → is obsolete as
> there is 
>   just the .po file format being described.
> * 11.1.3.: "This creates a new directory ..., which contains..." → no "," in 
>   English at this point.
> 
> Otherwise, changes look fine :) .

r72361 | cleaned up section 'Edit translation files'
Comment 7 Alexander Kläser univentionstaff 2016-09-07 13:46:16 CEST
Great, this looks good to me :) ! Thanks!

Could you merge the changes into 420?
Comment 8 Eduard Mai univentionstaff 2016-09-07 14:54:15 CEST
(In reply to Alexander Kläser from comment #7)
> Great, this looks good to me :) ! Thanks!
> 
> Could you merge the changes into 420?

Rev. 72367
Comment 9 Alexander Kläser univentionstaff 2016-09-08 13:18:10 CEST
OK → VERIFIED
Comment 10 Philipp Hahn univentionstaff 2016-10-10 16:48:36 CEST
r73053 | Bug #41045,Bug #41909,Bug #42091: doc PUBLISH