-
Type: Task
-
Status: Resolved
-
Priority: Major
-
Resolution: Fixed
-
Affects Version/s: 5.4, 5.5, 5.6 (LTS), Fast Track (FT)
-
Fix Version/s: None
-
Component/s: None
-
Tags:
Marketplace addons documentation should be organized as follow:
- Have "Marketplace addons" page in USERDOC, ADMINDOC, NXDOC, that displays the same content.
This content is created only once and displayed on the two other pages using the multi-excerpt-include macro. See http://doc.nuxeo.com/x/aoWo for content.
- This page should display a table with the list of all addons available for the platform version, with links to all available documentations, on this model:
Addon Public / Registered access Documentation Comment Amazon S3 Registered access [Administration documentation] Nuxeo Drive Public [User documentation]
[Technical documentation]
[Admin documentation]
- All addons should have a user and admin documentation. Admin documentation should at least hold the link to the addon on the Marketplace, and the link to the Installing a new package page.
- Documentations for a same addon should all have a common label, and all addon documentation should hold a content-by-label macro at the bottom of the page, so readers can easily access related pages. For instance at the bottom of 5.6 version of Drive user doc, we should have:
<ac:macro ac:name="contentbylabel"> <ac:parameter ac:name="spaces">@self ADMINDOC56 NXDOC56</ac:parameter> <ac:parameter ac:name="title">Related pages</ac:parameter> <ac:parameter ac:name="showLabels">false</ac:parameter> <ac:parameter ac:name="labels">drive</ac:parameter> <ac:parameter ac:name="showSpace">true</ac:parameter> <ac:parameter ac:name="type">page</ac:parameter> </ac:macro>
- Admin page should at least hold this content:
- excerpt from user documentation: The xxx addon enables users to / can /should be used to...
- Installation steps. Most of the time that would be : The xxx package requires no specific installation steps. It can be installed like any other package [from the Marketplace or from the Admin Center|Installing a new package].
- One sentence + one screenshot showing what it adds on the Platform.
- Optionnal configuration steps.
- Content-by-label macro (see paragraph above)
Examples:
Nuxeo CSV
Unicolor Flavors Set
Nuxeo Groups and Rights Audit