Uploaded image for project: 'Magnolia REST Client UI'
  1. Magnolia REST Client UI
  2. MGNLRESTUI-33

Relocate and update the magnoliaDocumentation search result supplier definition

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Obsolete
    • Neutral
    • None
    • None
    • None

    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.

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              Unassigned Unassigned
              mdrapela Martin Drápela
              DeveloperX
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Task DoD