Hi, On Thu, Sep 6, 2018 at 11:55 AM Nuwan Dias <[email protected]> wrote:
> I think we should make the comments visible both ways, on the Store as > well as the Publisher. Which means that when you put a comment on the > publisher, it becomes visible on the Store and vice versa. This way it > becomes simple and the publisher doesn't have to login to the Store to > put/reply-to comments and it will reduce a lot of the user stories above. > +1. I agree with this, logging in to API Publisher and API Store, unnecessarily complicates the scenario. And also I think we need to categorize comments as "Bug", "Feature Request" > or "General". > > In here, when implementing the search function, should we implement 2 types of searches or one search with both filtering by tags and typing keywords. I have an idea like this. We will have both tags and keyword search. By default it should be "ALL" when search starts. When typing keywords all the categories will be searched. Then you can change the tags while searching by keywords as you like. Thanks! Thanks, > NuwanD. > > On Thu, Sep 6, 2018 at 11:27 AM Wasura Wattearachchi <[email protected]> > wrote: > >> Hi, >> >> Thank you all for the feedback! >> >> So, as *Bhathiya* has mentioned, for the immediate release, we will be >> not considering the Use Case 2. >> As *Sanjeewa* mentioned, I also think it is better to go with full-text >> search only. +1 for that. Also, I really appreciate the idea of "Consumers >> can also reply to the comments". +1 for that too. >> >> I wrote User Stories for identified requirements. >> >> User Story ID >> >> As a <User_Type> >> >> I want to >> <Perform_Some_Task> >> >> So that I can <Goal> >> >> 1 >> >> Consumer >> >> Post a comment on API Store >> >> Share my experience and opinions about a particular API >> >> 2 >> >> Consumer >> >> Search comments which are already posted in API Store >> >> Have an understanding about a published API before using it >> >> 3 >> >> Consumer >> >> Reply to comments that are already posted by other Consumers in API Store >> >> Help other Consumers to clarify their doubts and problems, by sharing my >> experience and opinions (build a community) >> >> 4 >> >> Publisher >> >> Post a comment (by logging into API Store) >> >> Share prerequisites or important facts about a particular API >> >> 5 >> >> Publisher >> >> Post a comment (by logging into API Publisher) >> >> Share prerequisites or important facts about a particular API >> >> 6 >> >> Publisher >> >> Search comments which are already posted (by logging into API Store) >> >> Check what the consumers think about a particular API or issues >> >> 7 >> >> Publisher >> >> Search comments which are already posted (by logging into API Publisher) >> >> Check what the consumers think about a particular API or issues >> >> 8 >> >> Publisher >> >> Reply to comments that are published by Consumers (by logging into API >> Publisher) >> >> Clarify the doubts which consumers may be having >> >> 9 >> >> Publisher >> >> Reply to comments that are published by Consumers (by logging into API >> Store) >> >> Clarify the doubts which consumers may be having >> >> 10 >> >> Publisher >> >> Reply to comments that are published by other Publishers (by logging >> into API Publisher) >> >> Clarify the doubts that other Publishers may be having or accept/decline >> their opinions about a particular API >> >> 11 >> >> Publisher >> >> Reply to comments that are published by other Publishers (by logging >> into API Store) >> >> Clarify the doubts that other Publishers may be having or accept/decline >> their opinions about a particular API >> >> Also, I have some points to be clarified. >> >> 1. >> >> Consider User Stories 4 and 5. >> - >> >> I think this functionality has to be removed since this belongs to >> Use Case 2, which we are not considering in this release. >> >> If we remove this, automatically User Stories 10 and 11 will be removed >> too. >> >> - >> >> Is it really necessary that a particular Publisher can post a >> comment by logging into “API Store” and “API Publisher” both? >> >> I think it will be enough if we give this functionality through only API >> Publisher portal. >> >> 1. >> >> Consider User Stories 6 and 7. >> >> >> - >> >> Is it really necessary that a particular Publisher can search >> comments by logging into “API Store” and “API Publisher” both? >> >> I think it will be enough if we give this functionality through only API >> Publisher portal. >> >> 1. >> >> Consider User Stories 8, 9, 10 and 11. >> - >> >> Is it really necessary that a particular Publisher can reply to >> comments by logging into “API Store” and “API Publisher” both? >> >> I think it will be enough if we give this functionality through only API >> Publisher portal. >> >> 1. >> >> Also, what about API Creator? >> - >> >> Should we consider him as same as API Publisher or should we >> consider him as a separate role? >> - >> >> Or is it not necessary to consider API Creator at all? >> >> >> It will be a huge help if you can provide your feedback. >> >> Thank you, >> Wasura >> >> On Wed, Sep 5, 2018 at 3:50 PM Sanjeewa Malalgoda <[email protected]> >> wrote: >> >>> >>> >>> On Wed, Sep 5, 2018 at 3:16 PM Bhathiya Jayasekara <[email protected]> >>> wrote: >>> >>>> Hi Sanjeewa, >>>> >>>> On Wed, Sep 5, 2018 at 1:11 PM Sanjeewa Malalgoda <[email protected]> >>>> wrote: >>>> >>>>> >>>>> >>>>> On Wed, Sep 5, 2018 at 12:58 PM Wasura Wattearachchi <[email protected]> >>>>> wrote: >>>>> >>>>>> Hi All, >>>>>> >>>>>> The project that I have chosen for my internship is *"Project 240: >>>>>> Communication channel between API Providers and API Consumers"*. >>>>>> This is also related to the mail thread which is subjected as *"[Dev] >>>>>> [APIM 3.0] API Comments".* >>>>>> >>>>>> As I have gone through that mail thread, I clarified some doubts >>>>>> regarding this project. The *main points* that I have identified are >>>>>> as follows. >>>>>> >>>>>> *Point 1 - We must have “Facebook-like comments” MODIFIED our own >>>>>> way.* >>>>>> >>>>>> - >>>>>> >>>>>> One consumer can post more than one comment for a particular >>>>>> product. >>>>>> - >>>>>> >>>>>> Must have 2 main searching mechanisms. >>>>>> - >>>>>> >>>>>> Search by Tags (filters) >>>>>> - >>>>>> >>>>>> There are 3 types of tags, >>>>>> - >>>>>> >>>>>> “Feature Requests”, >>>>>> - >>>>>> >>>>>> “Bug Fixes” >>>>>> - >>>>>> >>>>>> “General Comments” >>>>>> - >>>>>> >>>>>> A Consumer can select a tag when posting a comment >>>>>> - >>>>>> >>>>>> Publishers can filter the comments by selecting a >>>>>> particular tag. >>>>>> - >>>>>> >>>>>> IMHO, I think it is better to give search by tags >>>>>> (filter) facility only for Publishers, so they can easily >>>>>> differentiate >>>>>> “Feature Requests”, “Bug Fixes” and “General Comments”. >>>>>> >>>>>> (Consumers will not have the facility to search by tags) >>>>>> >>>>>> - >>>>>> >>>>>> Search by keywords (just typing) - live search >>>>>> - >>>>>> >>>>>> IMHO, I think it would be better if both Consumers and >>>>>> Publishers have the ability to search, by just typing what has >>>>>> to be >>>>>> searched. >>>>>> >>>>>> If we are to implement tags then this would be too complicated. Cant >>>>> we just have full text search across all comments? >>>>> >>>>>> >>>>>> *Point 2 - There are 2 use cases for this scenario.* >>>>>> >>>>>> 1. >>>>>> >>>>>> Use Case 1 - Consumers can post comments on Store, and Publishers >>>>>> can see those. Also, Publishers can reply to those comments and those >>>>>> replies will be visible in the API Store, so anyone can see those. >>>>>> >>>>>> Its not only publisher, other consumers also should be able to reply >>>>> to them. Reason is if we are to build community of API users around store >>>>> then consumers should be able to reply. As example if one user asks >>>>> question about some client code generation related to API then publisher >>>>> it >>>>> not the ideal person to answer that. Its another consumer who uses that >>>>> client. >>>>> >>>> >>>> +1. >>>> >>>> >>>>> >>>>>> 1. >>>>>> >>>>>> Use Case 2 - Publisher initiated comments can only be seen by >>>>>> other publishers because those will be about API development and >>>>>> shouldn't >>>>>> be shared with API consumers. Those comments will not be available in >>>>>> the >>>>>> API Store. (So the Consumers may not have the ability to see those) >>>>>> >>>>>> I do not see value of doing this. As API creator or publisher what do >>>>> i have to tell other publishers. And what other publishers can comment >>>>> about my API. Its subscribers who use your APIs and they are the ones who >>>>> should initiate or read comments. >>>>> >>>> >>>> The reason for doing this is to cater colaborative development of APIs. >>>> In such cases, there should be a place for API developers to discuss and >>>> share their thoughts. We thought of developing a seperate UI for this. Also >>>> this will not be implemented for the immediate release. So we don't have to >>>> decide this at this point. >>>> >>> +1. That makes sense. >>> >>> Thanks, >>> sanjeewa. >>> >>>> >>>> Thanks, >>>> Bhathiya >>>> >>>> >>>>> >>>>> Thanks, >>>>> sanjeewa. >>>>> >>>>>> >>>>>> For further clarifications, you can go through the document which I >>>>>> have attached below. It will be hugely appreciated if you can provide >>>>>> your >>>>>> feedback. >>>>>> >>>>>> >>>>>> Until then I will analyze API Manager 3.0 more and will start writing >>>>>> User Stories. >>>>>> >>>>>> >>>>>> Thank you! >>>>>> -- >>>>>> Wasura Wattearachchi >>>>>> Software Engineer Intern | WSO2 >>>>>> >>>>>> Email: [email protected] <[email protected]> >>>>>> Mobile: +94775396038 >>>>>> >>>>> >>>>> >>>>> -- >>>>> *Sanjeewa Malalgoda* >>>>> WSO2 Inc. >>>>> Mobile : +94 712933253 >>>>> >>>>> <http://sanjeewamalalgoda.blogspot.com/>blog >>>>> :http://sanjeewamalalgoda.blogspot.com/ >>>>> <http://sanjeewamalalgoda.blogspot.com/> >>>>> >>>>> >>>>> >>>> >>>> -- >>>> *Bhathiya Jayasekara* >>>> *Technical Lead,* >>>> *WSO2 inc., http://wso2.com <http://wso2.com>* >>>> >>>> *Phone: +94715478185* >>>> *LinkedIn: http://www.linkedin.com/in/bhathiyaj >>>> <http://www.linkedin.com/in/bhathiyaj>* >>>> *Twitter: https://twitter.com/bhathiyax <https://twitter.com/bhathiyax>* >>>> *Blog: http://movingaheadblog.blogspot.com >>>> <http://movingaheadblog.blogspot.com/>* >>>> >>> >>> >>> -- >>> *Sanjeewa Malalgoda* >>> WSO2 Inc. >>> Mobile : +94 712933253 >>> >>> <http://sanjeewamalalgoda.blogspot.com/>blog >>> :http://sanjeewamalalgoda.blogspot.com/ >>> <http://sanjeewamalalgoda.blogspot.com/> >>> >>> >>> >> >> -- >> Wasura Wattearachchi >> Software Engineer Intern | WSO2 >> >> Email: [email protected] <[email protected]> >> Mobile: +94775396038 >> > > > -- > Nuwan Dias > > Director - WSO2, Inc. http://wso2.com > email : [email protected] > Phone : +94 777 775 729 > -- Wasura Wattearachchi Software Engineer Intern | WSO2 Email: [email protected] <[email protected]> Mobile: +94775396038
_______________________________________________ Architecture mailing list [email protected] https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
