-
Type: Task
-
Status: Resolved
-
Priority: Major
-
Resolution: Fixed
-
Affects Version/s: None
-
Component/s: Explorer
-
Epic Link:
-
Impact type:API change, Data Persistence Change
-
Upgrade notes:
-
Team:AT
-
Sprint:nxAT 11.1.16, nxAT 11.1.17
-
Story Points:3
The current documentation mechanism is a problem because:
- it implies persistence, that could be an issue when isolating the code logics to introspect a live instance without exposing explorer specific contributions, see NXP-28962
- the feature is not much used (and has been broken for a while actually, see
NXP-20246,NXP-23830) - content is difficult to review, see NXDOC-2111, and as far as i can see, is not currently visible anywhere on operations (the most documented ones).
Potential options:
- completely remove this feature, and maybe update contributions extracted to reference these external links directly in the introspected code (like it's already done on some operations)
- add a dedicated field in persisted distributions only, that would allow referencing documentation from doc.nuxeo.com by providing simple content (titles and links only?) and only reference these links, or embed them in frames
- drowback: these would need to be updated on each persisted distribution, at each release
Note the bundle and bundle group README from the GiHub repository was handled as a "documentation" item, so the corresponding documentation will be embedded directly on the bundle and bundle group instead.
As per nuxeo root pom configurations, maven will assemble this doc in the jar in subdirectories "doc" and "doc-parent". Patterns taken into account:
<include>*.md</include> <include>readme*</include> <include>ReadMe*</include> <include>README*</include>
BUT the main maven groups (at least in the nuxeo repository) are currently not that accurate, and parent documentation association with bundle group is currently buggy --> see how/if that information to be highlighted on the explorer.
- depends on
-
NXP-28915 Compute bundle and component requirements in Explorer
- Resolved
-
NXP-29219 Rework Explorer security model
- Resolved
-
NXP-28913 Improve Explorer webengine navigation and display
- Resolved
- is related to
-
NXP-29103 Fix explorer bundle group introspection and json
- Resolved
-
NXDOC-2111 Update links in explorer.nuxeo.com
- Open
-
NXP-23830 "Manage documentation" links give a 500 error
- Resolved
-
NXP-20246 Make some explorer pages more robust
- Resolved
-
NXP-28962 Split the explorer introspection and persistence features
- Open
-
NXP-29046 Fix some Nuxeo maven groups
- Resolved
- is required by
-
NXP-29025 Fix original component on operation chain
- Resolved
-
NXP-19497 Review Platform Explorer styles and UX
- Resolved
- Is referenced in