[MGNLRES-185] Replace add hot-fix action with edit resource action Created: 06/Aug/15  Updated: 29/Mar/22  Resolved: 03/Sep/15

Status: Closed
Project: Magnolia Resources Module
Component/s: None
Affects Version/s: None
Fix Version/s: 2.4.2

Type: Story Priority: Neutral
Reporter: Andreas Weder Assignee: Ilgun Ilgun
Resolution: Fixed Votes: 0
Labels: ux
Remaining Estimate: 0d
Time Spent: 7h
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)
Release notes required:
Yes
Date of First Response:
Epic Link: Phase out in-place templating app
Sprint: Sprint 7 (Basel), Sprint (Basel) 8
Story Points: 3
Team: Nucleus

 Description   

The idea here is that we remove "add hot-fix" and only offer "edit resource". More details here: https://wiki.magnolia-cms.com/display/UX/The+Resource+Files+app#TheResourcefilesapp-Editingaresourcefile

Acceptance criteria

  • updated documentation
  • have "add hot-fix" action removed
  • "edit resource" either edits an existing JCR resource file, or first copies a FS or CP resource file to JCR first, then edits it
  • have one-time notification shown in the editor tab, if a resource file has to be copied first


 Comments   
Comment by Andreas Weder [ 07/Aug/15 ]

Although this only covers the removal of "add hotfix", I suggest we do not ship this in a release without also at least renaming the "remove hotfix" action. Actually, this is covered here: https://jira.magnolia-cms.com/browse/MGNLRES-186

Comment by Ilgun Ilgun [ 17/Aug/15 ]

Changes can be found in feature/remove-hotfix-action/MGNLRES-185

Comment by Aleksandr Pchelintcev [ 20/Aug/15 ]

1) EditResourceFileAction - why not EditResourceAction? JavaDoc, consider this:

 * Action for editing a file within the Resources app.
 * <p>
 * This action will try to find the file for editing within {@value JcrResourceOrigin#RESOURCES_WORKSPACE} JCR workspace. 
 * If no such file exist then a so-called 'hotfix' will be created first, which involves importing a resource from classpath or file system into the {@value JcrResourceOrigin#RESOURCES_WORKSPACE} JCR workspace.
 * By doing this, the newly imported resource takes precedence over the original one in the resources loading cascade.
 * It may then be edited, on a live instance, and it may eventually be published to a public instance as well.

2) Comment in the code:

// notify eventBus for changed content.

You're notifying not an event bus, but the subscribers of an event. Pls change accordingly or remove.

3)

     static final String DETAIL_SUBAPP_NAME = "detail";
     static final String HOTFIX_SUBAPP_NAME = "hotfix";
     

why do we still need two sub-apps? since we do hot-fixing on the fly - why not always using the 'detail' sub-app? Pls clarify.

4) How does this actually replace anything? If you had the previous stuff in JCR (say you're migrating 2.4.0 version) - it's gonna remain in there. Pls use the correct MVH tasks and add MVH test which actually reproduces the replacements of the properties and actions.

  register(DeltaBuilder.update("2.4.1", "")
                .addTask(new NodeExistsDelegateTask("Replacing hotfixAction with editResource action.", "/modules/resources-app/apps/resources",
                        new BootstrapSingleResource("", "", "/mgnl-bootstrap/resources-app/config.modules.resources-app.apps.resources.xml"))));

5) Guess bootstrap file could lose the activationStatus related entries ('mgnl:activationStatus' and such)

6) We eliminate the 'Create hot fix' action but keep the 'Remove hot fix' one - how the new user's gonna find out what the hotfix is all about.

7) Translations:
--You're now editing a copy of the resource file, store in JCR. -> You're now editing a copy of the resource file stored in JCR. (!! - maybe a good place to mention the _hotfix term?? - pls check w/ Andreas)
Failed create copy of the resource file. -> Failed _TO create A copy of the resource file._
Cannot create copy of the resource file. -> Cannot create _A copy of the resource file._

8) Pls mind the formatting changes and such - try to not add unnecessary modifications, check the commits before pushing them.

9) Pls also check w/ Andreas if one time notification implies that it is shown once for each user

Comment by Ilgun Ilgun [ 21/Aug/15 ]

1) Simply because EditResourceAction already exists, JavaDoc improved accordingly.
2) Removed
3) We still have two apps because one used for preview, the other is for editing it. (Even if not, then it should be tackled in a separate task).
4-5) Fixed
6) We have a ticket for that.
7) Fixed accordingly.
8) Reverted unnecessary ones.

Changes can be found at the same branch.

Comment by Aleksandr Pchelintcev [ 21/Aug/15 ]
  • MVH tasks should be wrapped into NodeExistsTask where required
  • Fix checkstyle issues
Comment by Ilgun Ilgun [ 21/Aug/15 ]

Pushed into the same branch.

Comment by Jan Haderka [ 01/Sep/15 ]

Since the other action was already released we need to keep the class and deprecate it instead of just removing it w/o any notice or explanation so anyone using or struggling with old class can find the new one.

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