•  
     
    story #37543 edit sections
Summary
Empty
edit sections
Empty

Behaviour

  • Edition of sections requires an explicit action (dropdown > edit). The whole Section is toggled in Edit mode. The title and the description part of the section are separated. Both can be changed and there is an explicit “Save” action. There is a check to ensure that no data is lost on page leave.

  • The text can only be edited with the WYSIWYG editor (underlying storage is HTML). If the Description is stored in Markdown or Text, it's automatically converted to HTML at save time.

At save time:

  • Multiple sections can be edited in parallel but each section must be saved explicitly
  • in case of error
    • backend throw a 40X or 50X => the error message is displayed and there is a "Retry" and "Cancel" button (to let user modify the structure of the tracker for instance)
    • conflict (artifact updated in between) => the error message indicate that user is about to overwrite and have the possibility to "Force update" or "Retrieve the last version"

Permissions

  • In a given document, some Sections (artifacts) can be edited and some read-only
  • A given section is editable if user can Update both Title and Description fields.
Empty
Empty
Status
Artidoc
Done
Development
  • [ ] Does it involves User Interface? 
  • [ ] Are there any mockups?
  • [ ] Are permissions checked?
  • [ ] Does it need Javascript development?
  • [ ] Does it need a forge upgrade bucket?
  • [ ] Does it need to execute things in system events?
  • [ ] Does it impact project creation (templates)?
  • [ ] Is it exploratory?
Empty
Details
#37543
Manuel Vacelet (vaceletm)
2024-06-19 14:26
2024-03-28 15:23
38437

References
Referencing story #37543

Git commit

tuleap/tuleap/stable

feat: Indicates if user can edit document/sections dbcc1bb448
refactor: using provide/inject instead of slots and props 9b7873ac59
fix: remove target="_blank" from artidoc links 5b60efec65
refactor: Uniform way of retrieving sections e61ab1953f
refactor: Move the load of sections in store f478edf5e4
refactor: use stub for sections store 356a8cd61b
feat: Feature flag for artidoc edition c14b6c0de7
feat: Pinned header for artidoc f9f0705028
feat: add edit mode 0c09985119
fix: remove extra border for project w/ background 5069ec72a9
Revert "feat: add edit mode" 5b79bd3f55
refactor: remove duplication of pinned header management 1d60bfaabf
feat: introduce section id fe3ac80078
feat: add edit mode 489410e93f
feat: Display CKEditor in the user locale 77e18f9370
feat: async loading of the editor 84c1fc4c84
fix: artidoc should save new description as html d37b1112aa
feat: GET artidoc_sections/:id 762c38848e
fix: Correct management of value formats bdff4e89e1
feat: ckeditor toolbar is sticky 887eef3a98
feat: highlight section being edited 85481ef44a
feat: add edit section permission 5f4dd3ccc9
fix: disable code coverage for artidoc ed8bf660f9
feat: refresh description after save 9d4a218ff4
feat: Prevent browser to leave page during edition ed22938733
feat: Prevent browser to leave page during edition 4cbfcb6f14
feat: Highlight section depending on its status 7764074f0f
feat: Edition of title 3bce29dde7
feat: Concurrent edition of sections in artidoc 887051611f
feat: Dedicated message in case of 404 while editing a section 8a647b7e22
feat: handle 403 while editing a section 5c36ce75f8
feat: handle 400 and 500 errors d901ac09bb
feat: use ckeditor4 instead of ckeditor5 58165e82c8
feat: Edit/save buttons should be sticky d271031a33
feat: comfortable edition of title 4ea0c47d19
feat: Edition of artidoc is allowed by default a359ff0a0f
fix: inherit font-size for textarea 35ddd0298d
feat: cover section edition with e2e tests 12c1e2ea04
feat: add back test coverage in artidoc fb04ca28ae
feat: Introduce dropdown for section 1464d9ac10
fix: ckeditor toolbar should be visible when we scroll 1a3d062c36
Correct artidoc cypress test 9a49dd7ee4
fix: semantic order of the dropdown e1b92abc6b

Follow-ups

User avatar
  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
  • Status changed from On going to Done
User avatar
  • I want to
    -edit Artidoc sections 
    +edit sections 
  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
User avatar
  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
User avatar
  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
  • Category set to Artidoc