[PAGES-859] DOCS: Document that multiple Pages apps can be created Created: 03/Oct/22  Updated: 01/Nov/22  Resolved: 01/Nov/22

Status: Closed
Project: Magnolia pages module
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
Relates
relates to PAGES-894 Minimal Page Editor as LD example, in... Accepted
dependency
depends upon PAGES-858 DOCS: Provide a minimal example of an... Closed
relation
Sub-Tasks:
Key
Summary
Type
Status
Assignee
PAGES-906 DOCSub: Multiple Pages apps can be cr... Sub-task Completed Martin Drápela  
PAGES-907 DOCSub: Multiple Pages apps can be cr... Sub-task Completed Robert Šiška  
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)
Epic Link: Multiple PageEditor Apps
Sprint: DevX 22
Story Points: 3
Team: DeveloperX

 Description   

As a developer I want to know that it is possible to provision an app that behaves like the Pages App. I want to know why this is useful, and I want an description of how it is accomplished.

Note that as a first step we document getting it setup - but P13N is not yet documented - it is to be covered in a llater improvement. See PAGES-894

 

Linked ticket has a working example. I suggest this example be moved into the DOCS space and referenced from a page in Magnolia documentation.

Docs could go here: https://docs.magnolia-cms.com/product-docs/6.2/Apps/Developing-an-app.html

Would be good to update this page to indicate that you can create multiple "Page Editor" based apps: https://docs.magnolia-cms.com/product-docs/6.2/Features/Content-authoring.html

 

Rough Draft Suggestion:

Developers can provision the Page Editor UI in any app, creating a more powerful and intuitive Magnolia for their Authoring teams.

People want to use the Page Editor UI in other apps besides the Pages app.  For example to create a "Mobile" or "Kiosk" app to allow editing of multiple channels. Or they can create a "Reusables" app to allow creation of parts of pages which could be reused in many pages. This is supported in both freemarker and headlless mode.

You can create a custom app which works similar to the pages app, but is tailored to the needs of your project. For example you might want to provide a custom action to create a page that is linked to some external content. You can store the content in a custom workspace and with a custom node type.

Implementation

For reference see this code example of a custom pages app: (Ggit repo)

Here are the key factors to provision an app with the Page Editor UI.

A

B

C

Relevant Documents (Internal)

https://wiki.magnolia-cms.com/display/PMTEAM/Page+Editor+in+Any+App+-+Product+Sheet

https://wiki.magnolia-cms.com/display/PMTEAM/Page+Editor+Anywhere+-+Review

 

 


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