•  
     
    story #12264 display a custom banner inside project pages
Summary
project admin
display a custom banner inside project pages

I can inform users about project specific things

Functional overview

For project administrators

The banner is configurable by project administrators inside their projects.

Any project admin can set, update, remove a banner. There is no history of banner nor of setting / unsetting the banner.

The banner is limited to 1 line (no multiline) and limited formatting (bold, italic, links). It's pure html with only bold, italic and links (ckeditor for project admin).

In addition to web ui, there are 3 rest routes to set and delete the message

  • GET /projects/:id/banner
  • PUT /projects/:id/banner
  • DELETE /projects/:id/banner

For end users

They see the banner by default but they have the possibility to collapse the message (see banner-collapsed mockup). When they click the small megaphon icon.

There are 2 variations proposed of the banner, to be discussed. The first one is more consistent with the global look'n feel, the second one is more visible (maybe too much). Feedback welcomed.

Collapse is stored in user preferences (backend).

When message is changed/set, user preferences are removed (message will appear for everyone).

Only the first line of the paragraph is displayed, if the paragraph needs to be splitted over multiple lines there is an ellipsis and a click on the message display the whole text.

Technical overview

Developement must be done on FlamingParrot & BurningParrot themes.

Empty
Status
Empty
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
#12264
Manuel Vacelet (vaceletm)
2019-10-18 08:57
2018-09-13 13:45
3950

References
Referencing story #12264

Git commit

tuleap/tuleap/stable

Add a PUT route for /project/:id/banner 0612daa451
Add DELETE /projects/:id/banner REST endpoint 4574749f4d
Add GET route for /project/:id/banner 345db5fa91
Bootstrap project admin banner page aa7b737d72
Display project banner on BurningParrot pages 11dd3aaf7d
Bootstrap JS code for the project admin banner page bacb194196
The administration panel of the project banner can load translations c281e9f770
Display bullhorn on project burning parrot pages 44f48541ab
Display project banner on FlamingParrot pages 016a869b26
Display bullhorn on project Flaming Parrot pages 1673970b45
Add a webUI to DELETE project banner f4a7e36e57
Clamp the project banner message to one line 65cabc06fa
User can decide to hide the project banner 0a61dc1929
Users can hide or show again the project banner 477e21b616
Kanban height takes into account the project banner 0b2c0e6468
Have a textarea to set project banner's message d5db717f96
Add the 'Banner' entry to the project admin navbar ea3ba60484
Adjust apps height when a project banner is present dbe0742728
Close icon should always be on the right of the banner even with small message f3a150ba71
Opening the project banner should not interact with other apps c82338e564
Fix the display of the banner in Flaming parrot projects administrations pages 3ab0ffff04
Add CKeditor in project admin banner interface 62123ac01c
App height takes into account the project banner 97e3255a9c
Navigation breadcrumbs should always be before the toolbar c8a43a67aa
task #12264: Implement filter dd48a6a8aa

Follow-ups

User avatar
Thomas Gerbet (tgerbet)2019-10-18 08:57
gerrit #16485 integrated into Tuleap 11.7.99.2.

The richt text editor will not be available in the Tuleap 11.7 cycle so I'm attaching the story to Tuleap 11.8 as well.

  • Status changed from On going to Done
  • Category set to
User avatar
Thomas Gerbet (tgerbet)2019-10-03 15:35
Updating the acceptance criteria: instead of an arbitrary limit of 280 chars we only display the first line of the paragraph. This allow us to always have a banner with a consistent size on the first display across projects and users/resolutions.

  • 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
Martin GOYOT (goyotm)2019-09-25 17:59
  • 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
Martin GOYOT (goyotm)2019-09-23 17:11
Changed the routes from "motd" to "banner" and cleanup the dropped mockup.

  • 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
  • Attachments banner-displayed-v1.png removed
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
User avatar
  • So that
    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
  • 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