Bug 34645 - Documentation on UMCModuleName / README files
Documentation on UMCModuleName / README files
Status: RESOLVED WONTFIX
Product: UCS extended documentation
Classification: Unclassified
Component: Developer documentation
unspecified
Other Linux
: P5 normal (vote)
: ---
Assigned To: Docu maintainers
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2014-04-25 08:35 CEST by Moritz Muehlenhoff
Modified: 2024-04-17 13:16 CEST (History)
1 user (show)

See Also:
What kind of report is it?: Development Internal
What type of bug is this?: ---
Who will be affected by this bug?: ---
How will those affected feel about the bug?: ---
User Pain:
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:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Moritz Muehlenhoff univentionstaff 2014-04-25 08:35:13 CEST
The documentation on UMCModuleName is incomplete:

1. The documentation on UMCModuleName in "9.4. Application meta file" should mention that only one module is supported. If more than one is needed (e.g. in the SAML app or in UCC), a README file needs to be added instead.

2. If a README file is present, the UMCModuleName isn't used

3. The documentation on README files in 9.6 only generally mentions the possibility of using HTML. It should provide a specific example how to open a UMC module from the app description (if it is used as a replacement for UMCModuleName)

Example:

<p>The initial setup of a UCC environment for deploying desktops and/or thin clients occurs in the module <a href="javascript:void(0)" onclick="require('umc/app').openModule('udm', 'uccsetup')">UCC setup</a> after successful installation.</p>
Comment 1 Nico Gulden univentionstaff 2024-04-17 13:16:27 CEST
This bug hasn't seen any update for several years. I close it.

If you still see a need for it, you can reopen the bug. Please add an argumentation about why it's important to take care of it.