[MGNLRESTUI-33] Relocate and update the magnoliaDocumentation search result supplier definition Created: 28/Jul/20  Updated: 08/Sep/23  Resolved: 08/Sep/23

Status: Closed
Project: Magnolia REST Client UI
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Martin Drápela Assignee: Unassigned
Resolution: Obsolete Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Date of First Response:
Epic Link: RESTClient 2024
Team: DeveloperX

 Description   

1) To make Magnolia docs more readily available directly from the DX Core Find bar, move (and convert)

https://git.magnolia-cms.com/projects/MODULES/repos/periscope/browse/periscope-core/src/main/resources/periscope-core/searchResultSuppliers/magnoliaDocumentation.yaml

to 

https://git.magnolia-cms.com/projects/ENTERPRISE/repos/rest-client-ui/browse/declarative-rest-ui-demo/searchResultSuppliers

2) Enable the supplier and update the DOCS value specifying the Confluence space that is to be queried. Currently there's "DOCS60", which is EoL:

https://git.magnolia-cms.com/projects/MODULES/repos/periscope/browse/periscope-core/src/main/resources/periscope-core/searchResultSuppliers/magnoliaDocumentation.yaml#5

The universal DOCS cannot be used as value though. It is just a redirect on Apache, no such space exists. So, as a temporary workaround, for each major Magnolia branch and rest-ui module we could introduce these values:

UI Framework REST Extensions module version (branch) DOCS space version value
1.0.x DOCS62
1.1.x DOCS63
1.2.x DOCS64 or DOCS70 (?, we'll see)

and so on.

Note: Once our docs-as-code is functional, the supplier will have to be either rewritten or scratched altogether, the latter being more likely.



 Comments   
Comment by Christopher Zimmermann [ 08/Sep/23 ]

Is this still relevant mdrapela ?

Generated at Mon Feb 12 06:51:13 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.