Page Comparison

This document describes about Discussion Forum architecture

Background:

Problem Statement:

...

1. Categories list

   1. Category list with details

   2. Category list with only name(as a list)
      

      

      
      

2. Topics list

   1. Filter options & search query should be the config for the widget (optional for now)
      Note: Think this can be independent widget itself can be used at any place

      

      
      

3. Topic thread(with new post, list of posts & reply to post)

   

   
   

4. Create a Topic
   

   

5. Create Category
   

   

   
   

6. Post/Reply

   1. Post card

      

   2. Replay to post

      

   3. After posting the reply(expanded view)

...

Middleware/Proxy layer: List of API’s explosed & widget will communicate with these API’s

...

After review: 10/11/2020

Don’t introduce the hubs in between. The frontend should able to call directly the nodebb default API's without nodebb-plugin. It is not mandatory all the calls should go via nodebb-plugin only.

Image Added

Role Management:

...

Use authentication

Description:

Telemetry Events

Description: Telemetry events generated by discussion forum

Event Format:

{
    eid: INTERACT,
    edata: {
        id: 'category',
        type: 'CLICK',
        pageid: 'discussion-category',
    },
    context: [
        {
            type: Category
            id: {categoryId}
        },
        {
            type: Topic
            id: {topicId}
        },
        {
            type: Post
            id: {postId}
        },
    ]    
}

Integrating events triggered by the Discussion Library:

  import { DiscussionEventsService } from 'discussion-ui';
 
  constructor(private discussionEvents: DiscussionEventsService) { }

  ngOnInit() {
    this.discussionEvents.telemetryEvent.subscribe(event => {
      console.log('telemetryEvent', event);
    });
  }

telemetryEvent:

{
    eid: INTERACT,
    edata: {
        id: 'category',
        type: 'CLICK',
        pageid: 'discussion-category',
    },
    context: [
        {
            type: 'Category'
            id: '1'
        }
    ]    
}

{
  "eid": "IMPRESSION",
  "edata": {
    "type": "view",
    "pageid": "discussion-home",
    "uri": "/discussion"
  }
}

Related Wiki’s:

Discussion forum as a solution:

Discussions - Solution Design

Discussion forum api's:

Discussions - API Design

How to integrate discussion forum:

Discussion Forum: Integration

Discussion forum telemetry events:

Discussion Forum: Telemetry Events

Discussion forum generalization integration:

Discussion Forum: Generalisation of Course & Groups integration logic