galaniprojects / liveblog Goto Github PK

It should be clear, if the user can expect updates. If the feed is over, it should be marked as closed/finished.

• Setup REST module
• Setup Endpoint for CRUD operations for liveblog posts.

Setup webservice authentication. We might not need authentication for GET requests. We might not even need to use the services module for it. Needs research.

• Create administration forms for the custom entities (fields, display, CRUD for liveblog nodes, RUD for posts).
• Create administration views:
  • List all blogs, posts.
  • Add tab on the blog to list related posts, with edit and delete options.
• Configure permissions.
• Create administration links, tabs in admin menu.
• The posts adding/editing will be done at the frontend Drupal theme.

This should become effective after a day of closing the liveblog. It's sort of an archival view of the liveblog.

The javascript library will be a part of the Drupal Module:

• Timo needs to define paths of assets to load (readily built) and how to instantiate it. (frontend)
• It will be loaded via the regular Drupal library system.
• Attach the js,css files while the “Liveblog” rendering as a Drupal library. All the assets will be added as ajax commands to the JSON output.

Could be solved via the article sharing functionality in the Drupal article itself.

For example, if an event takes place on different locations, the user should be able to understand the regional context

Post create form:

• Form will be displayed on the liveblog page on top of all posts.
• Form will be loaded by Drupal and use Drupal ajax submission.
• Form has all the post’s fields + 2 buttons: preview, submit.
• Post preview click:
  • Ajax request to Drupal to preview a post. Drupal renders preview via Drupal ajax.
  • No instant preview is supported right now.
  • For the MVP, just rely on the preview button. Paragraphs already have a preview in the form.
• Post submit click:
  • Drupal creates a post via ajax.
  • Show success message.
  • The new post will appear automatically as a Pusher notification (Will be implemented in KUR-29).

Post edit form:

• A separate API endpoint is created to get the edit form HTML by post ID.
• When editor clicks the “edit” link on the post, edit form replaces the post (frontend part).
• Form is pre-populated with post fields.
• Post preview click:
  • Preview should work the same way as for the “Post create form”.
• Post submit click:
  • Ajax callback
  • Post will be updated.
  • Post edit form will be replaced with an HTML of an updated post via a Drupal ajax command. The frontend needs to implement the suiting ajax command for that.

When the editor deletes a post:

• Confirmation message is shown(frontend)
• Post deletion request in ajax (frontend)
• Post is removed from timeline (frontend)
• No pusher notification is sent.

I was told that this is the main liveblog issue tracker so posting here as well. Details about issue were already described here https://www.drupal.org/node/2862789

Implement render caching for posts endpoints, rendering.

• Implement render caching for posts.
• Cache views, posts HTML.

• Configurable via Ad-Tag.
• on/off switch
• Place every x entries
  • configurable

This includes Text, Image and Video.

Return post HTML by id

• Returns JSON with rendered html.
• Will initially return basic HTML, proper rendering will be done in KUR-25.
• Will be needed after edit a post.

Fetch posts (possible solution: views + serialization + filters + paging)

• Will return basic HTML, proper rendering will be done in KUR-25.
• Loads a certain amount of posts(as a JSON with rendered HTML) after a certain timestamp.

Setup permissions, access for posts.

• MVP: Default to editing permissions of the live blog. If so you are allowed to to edit the posts.
• Permissions are the same for all posts of a liveblog: Edit, view, delete, create posts. Means: Other editors can also edit your posts

Taken from BurdaMagazinOrg/thunder-distribution#261 (review):

If an editor changes the article of a liveblog, it would be nice, if these changes would be visible for the users, too.

Since the content will most likely exceed the limit of websocket services, we have to push the info to the clients, that they should get new content from the server.

This should be placed on top of a liveblog and explain what the liveblog is all about

No collaboration on single entries, but they should be able to push entries without conflicts.

It would be nice, if the live video would get into a smaller pip viewmode (like videos in the youtube app), if the user scrolls away from it, without pausing it.

It would be better to separate the code from the configuration.

Please move all the files from config/install besides liveblog.liveblog_post.settings.yml in a dedicated liveblog_example module.

• Make sure assets are propagated via AJAX commands during rendering
• Attach the js,css files while the “Liveblog” rendering as a Drupal library. All the assets will be added as ajax commands to the JSON output.

We should work mobile-first here

Integration with paragraph (optional module):

• Paragraph integration as an additional module // see existing paragraph integrations in Thunder.
• The module adds an additional field for embedding media links (twitter, youtube, etc.) to liveblog posts.
• Only 1 value should be possible: either twitter or youtube, or etc.

Create entities: Liveblog(node), Liveblog Post.
Enable default Drupal UI with CRUD forms.
Liveblog is created separately and can afterwards be referenced in the article.

Create entities:
Highlights (taxonomy)

• Name
  Liveblog fields (node type):
• Title
• Body - CKEditor
• Status. // An Indicator, if Liveblog is actually “live”, or already finished. We should NOT update live status via pusher.
• Highlights (term reference, multi-valued)
  • configuration for liveblog, contains highlighted options in a textarea.
  • Editor can choose while creating/editing a Liveblog.
    Liveblog Post fields (custom entity):
• Title
• Body - CKEditor
• Created Date
• Changed
• Author
• Location (Google maps link) // check google maps integration modules.
• Source (Quelle) // Link / Text.
• Status // Whether post is published
• Highlight (text field)
  • Text field, bus shows a select widget. Options are at liveblog. Adds the possibility to mark an entry as a highlight (e.g., goal, penalty, red card or more general like “all flights cancelled”) - adds icon.
  • On the liveblog post form we show a select list with the list of selected terms in liveblog.
  • The term is saved as a text machine name compatible with css class name.
  • In KUR-25 every highlight will be rendered as a CSS class, so developers can add an icon for it.
• Entityreference to Liveblog.

Configure ws server on pusher.com.
Integrate ws server as a pluggable notification channel.

• Add a setting for a notification channel plugin.
• We should load correct js files(library). Frontend will be also pluggable.
• Provide a default notification channel plugin
• Reloads page after a while in frontend.(frontend)

Create a pusher plugin

• Implement notifications via the pusher API.

We do not spread edit, delete events, only new posts.

Only, if the liveblog is "live".

Taken from: BurdaMagazinOrg/thunder-distribution#261 (review)

Add a description to the Liveblog content type

There needs to be another config for the pusher cluster.
Either as select, filled by Pusher API (if possible)
Or just as a string

This module should not have a dependency on Thunder.

Stuff that is needed to integrate with Thunder should be moved into the distribution.

Also visible for active users, which already became the entry.

Test coverage using PHPUnit // Use tests in Drupal core.

Either directly via Websockets, or via periodical refresh.
The user should keep his position in the liveblog, so that he won't have to scroll to keep reading the item of interest.

This should also be mobile first. A good, simple UX is key here.

Render posts with a proper HTML

• Add a display mode, template.

Posts list by Timo:

• Posts are listed below the form(frontend)
• Lazy load more posts on scrolling(frontend)
• Show edit/delete buttons for editor(frontend)

Taken from: BurdaMagazinOrg/thunder-distribution#261 (review)
When I make big post (>10kb), limit for Pusher is 10kb, error occurs in log, that it can't be pushed.
But in live blog form I get success message: "Liveblog post was successfully created."
In log: "Failed to send a message to Pusher. See the request log..."
And also, since it's not pushed to pusher, user does not see post until page is reloaded.
-> maybe it should be considered to notify editor about error occurred. Best would be to not create post in Drupal, if it's not pushed to pusher. In general this should be atomic action, so post is successfully created only if it's created properly in both places -> Pusher + Drupal.

For example, if an information was published over dpa, it should be displayed, that it is from dpa.

The Pusher config should be validated by the pusher service.

We should try to make a request and see, if it returns 200

Taken from: BurdaMagazinOrg/thunder-distribution#261 (review)

Looks like that sometimes content is not loaded properly. Fe. If I create 2 posts really quickly (withing same minute) with titles 123 and 456 (in that order). Post will be correct in stream, when I reload page order is reverse and 123 is displayed before 456.

This includes entries from other editors